En este post les quiero mostrar una estructura básica de un proyecto web (API REST) con NodeJS en el back end.
Les dejo el repositorio donde pueden descargar una estructura básica de un proyecto web (API REST) con NodeJS. Click aquí
Algunas cosas a destacar:
Estructura de carpetas
Dividir la estructura separando en config, controllers, i18n, middleware, routes, etc. La idea es separar en un proyecto de varias partes para poder mantener mejor.
Internacionalización
Tu aplicación debe de estar preparado para soportar la internacionalización.
Utilizar
- Archivo .env para las constantes del sistema
- Babel para soportar JavaScript ES6 y versiones posteriores.
- Webpack para compilar, etc
Testing automático
El testing automatico es una inversión a corto, mediano y largo plazo. Te va a facilitar mucho el trabajo cuando haya modificaciones en tu proyecto, nuevas funcionalidades, etc. Te da una mejor seguridad en realizar los cambios sin miedo a romper algo anterior.
Archivos necesarios:
CHANGELOG.md
En el archivo CHANGELOG.md debe de estar todos los cambios del proyecto para poder leer de una forma sencilla lo que se va implementando como nuevas funcionalidades, correcciones de errores, etc.
README.md
En el archivo README.md debe de estar toda la documentación necesaria del proyecto.
TODO.md
El archivo TODO.md se indica las nuevas funcionalidades o las tareas que faltan realizar.
Documentación API para el desarrollador
Como es una API REST debemos de dar acceso a una documentación clara para el desarrollador. En nuestro caso utilizamos Swagger.
Imagen destacada: Wikipedia
Les dejo el repositorio donde pueden descargar una estructura básica de un proyecto web (API REST) con NodeJS. Click aquí