El proyecto está enfocado en los aspectos operacionales de un proceso de marketplace ecommerce típico, con el propósito de crear un API que de la capacidad de tener usuarios, productos, categorías y transacciones
Se utilizó para la creación del backend:
- NodeJS + ExpressJS
- Sequelize + PostgreSQL
- Docker + Docker-compose
El proyecto está estructurado con la idea de mantener los principios del Clean Code Architecture. La aplicación corre con un archivo de variables de entorno, los cuales pueden ser cambiados para crear una base de datos diferente o conectarla a una ya existente (revisar .env). Además de esto, se brinda una colección de postman para probar y utilizar las rutas creadas.
Los pasos para correr el proyecto son:
- Clonar el repositorio.
docker compose up -d node_backend
para poder subir el servicio del backend, que depende de la base de datos.- Correr la coleccion de postman completa para ver resultados.
Si no se desea correr la colección completa, pues se puede abrir cada ruta y empezar a probar como se desee.
Los pasos para correr el proyecto desde su propia máquina sin docker son:
- Clonar el repositorio.
- Correr el comando
npm install
para conseguir todas las dependencias. - Ir al
.env
y cambiarSEQUELIZE_HOST
. Este está pautado con la variable'db'
por razones de docker. Si se desea correr local deberá de cambiar'db'
por'localhost'
- Fuera de la carpeta
/src
utilizar el comandonode index.js
para correr el proyecto. - Correr la coleccion de postman completa para ver resultados.