VUE-API

Instalación

1. Clonar el repositorio

$ git clone https://github.com/LaloG19/LaloG19

2. Dependencias

# Para instalar dependencias ejecuta este comando en la raíz:
$ npm install

3. Credenciales

# Antes de ejecutar el servidor, asegurate de crear tu archivo .env

DB_USER=USER
DB_PASSWORD=12345
DB_HOST=localhost:3000
DB_NAME=Solve
DB_PORT=3307
PORT=3000

Linter

Este proyecto tiene reglas de eslint y prettier configuradas, se re comienda instalar as extenciones respectivas en visual studio code:

Eslint : dbaeumer.vscode-eslint

Prettier : esbenp.prettier-vscode

Configurar el formateador por defecto

# Dentro del IDE
Ctrl + Shift + P
# Seleccionar "Format Document With"

# Seleccionar a prettier como formateador por defecto

Ejecutar el servidor

# Desarrollo:
$ npm run dev

# Formatear el código en general

$ npm run lint

Estructura de carpetas

├─ src
│   ├───controllers
│   │
│   ├───database
│   │
│   ├── middlewares
│   │
│   ├───models
│   │
│   ├───routes
│   │
│   └───schemas
│
├── .env
│
├── README
│
├── app.js
│
├── index.js
│
└── swagger.options.js

Swagger

Swagger es una herramienta usada para documentación de API y testing

Una vez la aplicacon se este ejecutando debe entrar en la siguiente URL:

https://backup-production-9704.up.railway.app/docs/

Formato de los commits

Nota:

El merge de los pull request debe ser de tipo "Squash and merge"

Actualización de archivos existentes -> up

#Ejemplo

$ git commit -m 'up: mensaje en index.ts '

Refractorización de archivos/carpetas existentes -> rf

#Ejemplo

$ git commit -m 'rf: se movieron los modulos a la carpta src/ y se actualizaron los imports '

Agregar una nueva funcionalidad -> ft

#Ejemplo

$ git commit -m 'ft: ruta para obtener los paises agregada'

Corrección de errores -> fix

#Ejemplo

$ git commit -m 'fix: conexion con la base de datos'

Formato de las ramas

#Ejemplos

# Nueva funcionalidad
branch -> ft/modulo-contactos

# Bugs
branch -> fix/conexion-base-de-datos

#Refractorización
branch -> rft/estructura-carpetas