En este capítulo, examinaremos más de cerca la estructura del proyecto. Mantener una estructura bien organizada se vuelve crucial a medida que desarrollamos toda la aplicación. A continuación, se describen los directorios y archivos clave que encontraremos en nuestro proyecto:

Archivos Iniciales del Proyecto

Puedes acceder a los archivos y carpetas iniciales del proyecto en Github Si eres nuevo en GitHub, sigue el sencillo proceso de dos pasos ilustrado a continuación para descargar el proyecto.

Descripción General de la Estructura del Proyecto

Analicemos el propósito de cada directorio y archivo. La imagen a continuación proporciona una representación visual de la estructura del proyecto:

Ahora, analicemos el propósito de cada directorio y archivo:

1. index.js: Sirve como punto de entrada principal de la aplicación. En este archivo, se configura el servidor Express, se establecen los middleware, se definen las rutas y se inicia el servidor;

   • Inicialización de la aplicación Express;
   • Configuración de middleware, como express.json(), para el análisis de solicitudes JSON;
   • Definición de rutas y middleware para el manejo de errores;
   • Inicio del servidor Express en un puerto específico (por ejemplo, 3000).

2. routes/: Este directorio contiene las definiciones de rutas para los distintos endpoints de la API. Organizar las rutas en módulos separados ayuda a mantener el código limpio;

   • Creación de archivos de rutas distintos para diferentes funcionalidades (por ejemplo, gestión de usuarios, tweets, publicaciones, autenticación);
   • Organización y modularización del código de manejo de rutas.

3. routes/postsRoutes.js: Maneja específicamente las rutas relacionadas con las publicaciones (tweets) dentro de la aplicación;

   • Definición de rutas para crear, obtener, actualizar y eliminar publicaciones (tweets);
   • Gestión de las interacciones con el archivo de datos posts.json.

4. middlewares/: Las funciones middleware almacenadas en este directorio son esenciales para tareas como validación, autenticación y autorización. Promueven la reutilización de código;

   • Separación de funciones middleware en módulos individuales;
   • Uso de middleware para tareas como validación de datos, autenticación de usuarios y manejo de errores.

5. middlewares/validateData.js: Esta función middleware se centra en la validación de datos dentro de las solicitudes entrantes. Garantiza que los datos enviados cumplan con los criterios requeridos;

   • Examinación de los datos entrantes para verificar su corrección antes de procesarlos;
   • Respuestas de error apropiadas en casos de datos inválidos o faltantes.

6. database/: Este directorio alberga el almacenamiento de datos de la aplicación;

7. database/posts.json: En este archivo, se almacenan los datos (en este caso, publicaciones) en formato JSON;

8. node_modules/: Se genera automáticamente al ejecutar npm i express. Este directorio contiene todas las bibliotecas y módulos externos utilizados en el proyecto;

9. package.json y package-lock.json: Estos archivos enumeran todos los paquetes de los que depende el proyecto.