Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 97 additions & 0 deletions README.es-ES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
# LADA - League of Legends Assistant Desktop App

Es una aplicación de escritorio que cuenta con diversas funciones como búsqueda de historial de League of Legends, configuración automática de tiers de campeones, runas e ítems, entre otras.<br />
Este proyecto es un proyecto personal (toy project), por lo que el periodo de desarrollo puede ser irregular.<br />

<br/>

## i18n support
El idioma predeterminado se establece detectando qué idioma utilizas, y también puedes cambiarlo directamente en la página de Ajustes (Settings).

<br/>

## Features
- Información estadística básica como tiers de campeones y sinergias de dúo
- Configuración automática de runas y hechizos al seleccionar un campeón
- Búsqueda de campeones mediante alias (ej. Tristana = 트타)
- Información en tiempo real dentro de la partida
- Aceptación automática de emparejamientos (Matchmaking)
- Soporte multiidioma i18n (Coreano, Inglés)

<br/>

## Screenshots

![image](https://github.com/2skydev/LADA/assets/43225384/d3d9a37c-3b26-4d2d-ad58-782c37b95240)
![image](https://github.com/2skydev/LADA/assets/43225384/d1fdfd9b-338f-42bb-8aec-44c5997e5495)
![image](https://github.com/2skydev/LADA/assets/43225384/842dbbc4-3d9b-452e-9b71-e52e66930b4e)
![image](https://github.com/2skydev/LADA/assets/43225384/9a0deb72-934b-4643-9e9a-56a6d6616a01)
![image](https://github.com/2skydev/LADA/assets/43225384/cb186443-6477-4942-933a-5b639cb8cc34)
![image](https://github.com/2skydev/LADA/assets/43225384/804708fb-256f-4883-9542-5c8f3a5a97b6)
![image](https://github.com/2skydev/LADA/assets/43225384/71a44a18-f6e5-4908-92d6-989fdd9f4d6a)

## Architecture

> [Figma link](https://www.figma.com/file/qJrFt4YVAZX5UdbeKLx6xA/LADA?type=whiteboard&t=oozV2tgJvZuRd6S4-1)

![image](https://github.com/2skydev/LADA/assets/43225384/a4de6e74-4788-424c-a3f0-a329c853789a)

## Github workflow

> [Figma link](https://www.figma.com/file/qJrFt4YVAZX5UdbeKLx6xA/LADA?type=whiteboard&t=oozV2tgJvZuRd6S4-1)

![image](https://github.com/2skydev/LADA/assets/43225384/69dc01b1-0fab-4305-9e69-6821555119fe)

<br/>

## Code style guide

[Code style guide markdown](https://github.com/2skydev/LADA/blob/main/CODE_STYLES.md)

<br/>

## Start develop

#### dev mode

```bash
yarn dev
```

#### vite & electron build

```bash
yarn build
```

<br/>

## Overview framework & library

- App framework: [`electron`](https://www.electronjs.org/)
- App build tool: [`electron-builder`](https://www.electron.build/)
- App storage: [`electron-store`](https://github.com/sindresorhus/electron-store)
- App auto updater: [`electron-updater`](https://www.electron.build/auto-update)
- Bundle tool: [`vite`](https://vitejs.dev/) + [`electron-vite`](https://electron-vite.org/)
- Main process framework: [`nestjs`](https://nestjs.com/)
- Renderer process framework: [`react`](https://react.dev/) + [`typescript`](https://www.typescriptlang.org/)
- Code style: `eslint` + `prettier` + [`@trivago/prettier-plugin-sort-imports`](https://github.com/trivago/prettier-plugin-sort-imports)
- File system based router: [`react-router-dom v6`](https://reactrouter.com/docs/en/v6) + custom (src/components/FileSystemRoutes)
- CSS: [`styled-components`](https://styled-components.com/)
- State management library: [`jotai`](https://jotai.org/)
- Date: [`dayjs`](https://day.js.org/)
- i18n: [`i18next`](https://www.i18next.com/) + [`react-i18next`](https://react-i18next.com/)

<br/>

## Todo

- [x] Lista de tiers de campeones
- [x] Obtención del usuario logueado en el cliente de LoL
- [x] Función de aceptación automática de emparejamientos
- [x] Página de detalles del campeón
- [x] Configuración automática de runas del campeón
- [ ] Configuración automática de ítems del campeón
- [ ] Página de búsqueda de historial
- [x] Página de información en juego
- [ ] Añadir función de overlay