Logo NodeJS (imagen destacada)

Tiro monedas al aire, pero hasta ahora nunca las pude agarrar.

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

Estructura carpetas en un proyecto NodeJS
Estructura carpetas en un proyecto NodeJS

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

Internacionalización en un proyecto NodeJS
Internacionalización en un proyecto NodeJS

Tu aplicación debe de estar preparado para soportar la internacionalización.

Utilizar

Archivos útiles en un proyecto NodeJS
Archivos útiles en un proyecto NodeJS
  •  Archivo .env para las constantes del sistema
  •  Babel para soportar JavaScript ES6 y versiones posteriores.
  •  Webpack para compilar, etc

Testing automático

Testing automático en un proyecto NodeJS
Testing automático en un proyecto NodeJS

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

Archivo CHANGELOG en un proyecto NodeJS
Archivo CHANGELOG en un proyecto NodeJS

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

Archivo README Proyecto NodeJS
Archivo README Proyecto NodeJS

En el archivo README.md debe de estar toda la documentación necesaria del proyecto.

TODO.md

Archivo TODO en un proyecto NodeJS
Archivo TODO en un proyecto NodeJS

El archivo TODO.md se indica las nuevas funcionalidades o las tareas que faltan realizar.

Documentación API para el desarrollador

Documentación API Proyecto NodeJS
Documentación API Proyecto NodeJS

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í

Comments

comments


Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *