Estructura de carpetas Sistema de gestión de riesgos (Servidor)
Y cómo iniciar todo el entorno de trabajo.
Con este documento se pretende explicar cómo será la estructura de carpetas del servidor del
sistema gestor de riesgos, con la finalidad de dar claridad a los miembros del equipo de donde
deben crear y trabajar sus respectivos archivos con sus responsabilidades.
Primero que nada, la carpeta donde se va a trabajar el backend será la carpeta server, allí
estará todo lo referente al servidor, así que al clonar el repositorio, moverse a esta carpeta
para iniciar a trabajarla.
Dentro de la carpeta carpeta server, solo nos interesa la carpeta src ya que estará alojado todo
el proyecto que trabajaremos, por favor los demás archivos NO tocarlos.
En la carpeta src encontraremos los siguientes archivos con las siguiente descripciones
Archivo [Link]: Es el archivo principal donde solo se inicia el servidor, por favor NO modificar.
Archivo [Link]: Archivo donde se inicializa express JS se agregarán los middlewares y se
activan las rutas.
Carpeta database: Aquí encontraremos los archivos de configuración de la base de datos, por
favor NO modificar.
Carpeta middlewares: Aquí se almacenan los middlewares personalizados que manejen
errores o validaciones comunes. Ejemplo de middleware para manejar errores
Carpeta módulos: Esta es la carpeta más importante, aquí es donde trabajaremos todos y
cada uno de los módulos que vamos a trabajar con sus respectivos controladores, rutas,
servicios, modelos y repositorios. Cada elemento del sistema (riesgos, activos, etc…) será un
módulo aparte, por ello cada uno tendrá su propia carpeta. Dentro de cada módulo se tendrán
5 archivos que serán los siguientes, con la siguiente nomenclatura.
- Archivo controlador ({modulename}.[Link]): Archivo que manejará la lógica de
negocio de cada ruta y llamará las funciones apropiadas del archivo de servicio.
Ejemplo:
- Archivo de rutas ({modulename}.[Link]): Es el archivo que maneja las rutas para
las distintas operaciones del módulo. Cada endpoint utilizará una función definida en el
controlador.
Ejemplo:
- Archivo de servicios ({modulename}.[Link]): Se define la lógica de negocio y
las operaciones que manipulan los datos que vienen desde el archivo repositorio.
Ejemplo:
- Archivo de repositorios ({modulename}.[Link]): Contiene los métodos que
interactúan directamente con la base de datos usando Prisma.
Ejemplo:
- Archivo de modelos ({modulename}.[Link]): Define las clases del modelo, donde
colocaremos todos los atributos y métodos de la entidad
Ejemplo:
Con esto cubrimos todo lo referente a la estructura de carpetas para trabajar el
proyecto.
Como segundo apartado se dejarán las instrucciones para iniciar a trabajar en el
servidor sin tener errores y no morir en el intento.
1. Clonar el repositorio, acceder a la carpeta server (cd server), e iniciar en su IDE
o editor de código favorito.
IMPORTANTE: Si no les deja clonar el repositorio por el protocolo
HTTPS, deben clonarlo por el protocolo SSH (El repositorio viene con
restricciones de seguridad). Para clonar por ssh deben tener una SSH KEY en
sus equipos, no es muy complejo pero es un paso extra, aqui les dejo el enlace
para crear una llave SSH y agregarla al GitHub, si tienen dificultades también me
pueden preguntar, con gusto les colaboro: GenerarSSH
2. Es necesario tener Node JS instalado en el equipo.
3. Instalar todas las dependencias del proyecto con el siguiente comando npm
install
A la hora de trabajar con prisma, es necesario realizar unos pasos para poder hacer una
correcta conexión y no tener errores en la ejecución.
1. Manualmente deben crear un archivo para variables de entorno y se debe llamar
así: .env
2. Este archivo lo deben crear fuera de todas las carpetas, que quede al mismo nivel de la
carpeta src
3. En la variable de entorno colocan la cadena de conexión, aquí se las dejo. POR
FAVOR, NO compartir esto con nadie que no sea del equipo.
DATABASE_URL="postgresql://
[Link]:Wu82RJbD98wBltt3@aws-0-us-east-
[Link]/postgres?pgbouncer=true"
4. Procede a inicializar los esquemas de prisma con el siguiente comando (Este
paso solo lo hacen la primera vez que clonen el repositorio):
npx prisma generate
5. Ya tenemos el entorno preparado para iniciar el servidor de desarrollo.
6. Iniciamos el servidor con el comando: npm run dev