Para correr correctamente el proyecto el usuario debe tener instalado:
También tener un archivo llamado .env (ubicado en la raíz del proyecto) que tenga la siguiente estructura:
MONGODB_URI = <mongo_url>
POSTGRES_URI = <postgres_url>
SESSION_KEY = <key>
Si se quiere correr el proyecto de forma local se deben correr los scripts:
- script_postgres
Para el caso de MongoDB se debe correr el siguiente comando
db.createCollection(Notes)
- src: carpeta base del proyecto
- models: contiene los schemas para representar la informacion, en este caso solo las Notas.
- views: vistas de FrontEnd simples en .ejs para testear la funcionalidad.
- dbConfig.js: archivo de configuración para la conexión con la Base de Datos PostgreSQL.
- passportConfig.js: Validación de usuarios:contraseña.
- server.js: aplicación Node.
- swagger.js: archivo con la configuración de Swagger.
Instalar todas las dependencias
npm install
Correr la aplicación
npm run dev
Se levantara una aplicación Node. La documentación mediante Swagger se encuentra en /api-doc