Instalación • Uso • Contribuciones • Estructura

npm install

1. Podes ver los comandos que están dentro del package.json. Para levantar el servidor node podes ejecutar:

npm run start:dev

• Franco Di Leo

💡 Protip: Puedes ver el historial de commits para saber quien es uno de los miembros más activos del proyecto en GitHub.

1. Clona el repositorio:

   $ git clone https://github.com/dileofrancoj/nodejs-base-boilerplate
   

2. Luego ya podras intalar todas las dependencias, para empezar a trabajar.

   $ npm install
   

Los mensajes de commits deben estar en Inglés y seguir el estandar de conventional commits. No es necesario leer toda la especificación, sino empezar por entender el patrón básico:

type(scope?): subject

💡 Protip: Puedes ver el historial de commits de este proyecto para ver algunos ejemplos en concreto.

A la hora de crear un PR, se parte de la rama main y se crea una branch a partir de la siguiente convención: Commitlint

Cada componente debe seguir la siguiente estructura de archivos:

├── 📂 src
| ├── 📂 config                 // environment config
| ├── 📂 services               // General services
| ├── 📂 utils                  // General utils
| | ├── 📄 errorHandler.js      // Base error handler
| ├── 📂 api                    // all entities
| | ├── 📂 entity               // single entity
| | ├──── 📄 routes.js
| | ├──── 📄 controller.js
| | ├──── 📄 validation.js
| | ├──── 📄 model.js
| └── 📄 index.js                // entry point

Opcionalmente un folder __tests__ si es que lo requiera:

...
├── 📂 folder
| ├── 📂 __tests__
...