https://github.com/felipetodev/todo-mysql
to-do list with mysql db 📝
https://github.com/felipetodev/todo-mysql
express mvc-architecture mysql-database nodejs pnpm-workspaces reactjs shadcn-ui tailwindcss vitejs
Last synced: 2 months ago
JSON representation
to-do list with mysql db 📝
- Host: GitHub
- URL: https://github.com/felipetodev/todo-mysql
- Owner: felipetodev
- License: mit
- Created: 2024-06-12T20:06:45.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-21T16:04:53.000Z (almost 2 years ago)
- Last Synced: 2024-12-28T12:13:22.180Z (over 1 year ago)
- Topics: express, mvc-architecture, mysql-database, nodejs, pnpm-workspaces, reactjs, shadcn-ui, tailwindcss, vitejs
- Language: TypeScript
- Homepage:
- Size: 251 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Todo List - MySQL App
https://github.com/felipetodev/transvip-chall/assets/69825873/da007103-fdf0-4cae-8a52-2aea5df728f2
## 🚀 Primeros pasos (Proyecto)
Clona el repositorio en tu máquina local y luego estando en la raíz del proyecto, ejecuta el siguiente comando:
```bash
pnpm install
```
Este comando instalará todas las dependencias necesarias para correr el proyecto, tanto en el front como en el back. Ya que el proyecto cuenta con un archivo `pnpm-workspace.yaml` que permite instalar las dependencias de todos los proyectos a la vez.
Una vez instaladas las dependencias, se debe ejecutar el siguiente comando para correr el proyecto:
```bash
pnpm dev
```
o puedes correr el proyecto de manera individual con los siguientes comandos:
```bash
pnpm -F frontend dev
```
```bash
pnpm -F backend dev
```
Este comando correrá tanto el front como el back del proyecto. El front se ejecutará en el puerto `4000` y el back en el puerto `3000`.
> [!IMPORTANT]
> - Antes de levantar todos los servicios, se debe tener el servidor de MySQL corriendo. Si no se tiene instalado, se puede seguir los pasos que se encuentran más abajo.
> - La versión minima requerida de Node.js para correr el proyecto es desde la **18.x** en adelante (LTS).
## Primeros pasos (MySQL Server)
Para correr el proyecto con MySQL, de utilizó DBngin, una herramienta que permite correr MySQL en MacOS de manera sencilla. Para instalarlo, se puede hacer desde [aquí](https://dbngin.com/).
Si estás en Windows, puedes utilizar MySQL Workbench o cualquier otro cliente de MySQL con una instancia local apuntando a localhost.
Una vez instalado, se debe agregar un nuevo servidor MySQL y configurar la base de datos con los siguientes datos utilizados:
- **Service:** MySQL (requerido)
- **Name:** todolist-database
- **Port:** 3306 (por defecto) o el que corresponda en tu caso.
- **Password:** '' (sin contraseña) o la que corresponda en tu caso.
Esto para que la conexión con el servidor de MySQL sea exitosa.
También puedes configurar la conexión con los datos de tu DB renombrando el archivo [**.env.example**](backend/.env.example) a `.env` ubicado en la raíz de la carpeta `backend` reemplazando los valores por los de tu config.
⚠️ MySQL Connection Config: [**backend/config.ts**](backend/config.ts) ⚙️
Una vez activado el servidor, se debe ejecutar el script de sql el cual se encuentra en la carpeta `script/todolist-database.sql` en la raíz del proyecto.
Para ello puedes utilizar MySQL Workbench o cualquier otro cliente de MySQL.
## 🛠️ Tecnologías utilizadas
- **Frontend:** TypeScript, Vite.js, React, TailwindCSS, Redux Toolkit, ShadCN.
- **Backend:** TypeScript, Node.js, Express, MySQL.
## 📝 Features
- [x] Crear una tarea
- [x] Listar todas las tareas
- [x] Marcar una tarea como completada
- [x] Eliminar una tarea
- [x] Persistencia de datos en MySQL
- [x] Estado global de aplicación con Redux Toolkit
- [x] Workspaces con pnpm para manejar dependencias de front y back
- [x] Editar descripción de una tarea
## 🔑 Licencia
- [MIT](https://github.com/felipetodev/todo-mysql/blob/main/LICENSE).