OliverZulett/Base-API

Repositorio con el contenido escencial para crear una REST API escalable y sostenible

BASE API

Hola! esta es un setup básico para una API desarrollada con expressJS y Typescript

Comenzando 🚀

Estas instrucciones te permitirán obtener una copia del proyecto en funcionamiento en tu máquina local para propósitos de desarrollo y pruebas.

Pre-requisitos 📋

Que cosas necesitas para instalar para que la API funcione:

Nodejs > 14

Ejecución🔧

Para poder ejecutar la APP necesitas seguir los siguientes pasos

1. Abre una terminal desde la raíz del repositorio y ejecuta el siguiente comando para instalar todas las dependencias de Node que necesita la API para funcionar.

npm install

2. Para ejecutar la API en modo desarrollo (se re compila automáticamente cuando haces algún cambio).

npm run start:dev

2. Para ejecutar la API en modo producción.

npm run start:prod

3. Para ejecutar los Unit Test.

npm run test

Project Structure 🛠️

estos son los archivos y carpetas que te interesaria modificar

repository
│   .env                //--> aqui modificamos las variables de entorno
│   src                 //--> carpeta del proyecto
│   │   server.ts       //--> aqui cargamos el servidor
│   │   app.ts          //--> aqui cargamos las rutas
│   └───routes          //--> aqui creamos las rutas para cada recurso
│   └───controllers     //--> aqui creamos los controladores para cada recurso
│   └───services        //--> aqui creamos los servicios para cada recurso

Construido con 🛠️

herramientas que se utilizaron para crear este proyecto

• ExpressJs - El framework de nodejs.
• Nodejs - Plataforma de ejecución.
• Typescript - El lenguaje de programación.

Contribuye 🖇️

Si quieres contribuir con el desarrollo y mejora de esta API, solo sigue estos pasos.

1. cuando realices un Pull request recuerda que cambios estas realizando y por que.
2. Comenta bien las líneas de código que modifiques.
3. Utiliza el tipado fuerte de Typescript.
4. Utiliza principios de código limpio.
5. Ten en cuenta que esta API tiene propósitos de aprendizaje así que realiza cambio simples para no confundir a los que recién comienzan con el desarrollo Back End.

Autores ✒️

Hasta ahora solo yo, pero estoy esperando mas colaboradores:

• Oliver Zulett - Desarrollo - OliverZulett

Licencia 📄

Este proyecto está bajo la Licencia (MIT) - mira el archivo LICENSE.md para detalles

Expresiones de Gratitud 🎁

• Comenta a otros sobre este proyecto 📢
• Da las gracias públicamente 🤓.