Weekly Mission 4
- Jest: Es una librería que nos permite escribir y ejecutar tests.
Documentación: https://jestjs.io/docs/api
- EsLint: Es una herramienta de código abierto, que nso ayuda a limpiar nuestro código, podemos agregarle las reglas que necesitemos, y con un solo comando te muestra los errores y con otro los corrige.
Documentación : https://eslint.org/docs/rules/
- Express Server: Nos ayuda a crear servidor para nuestra API.
Documentación: https://expressjs.com/es/
https://aliciagaona.github.io/my_launchx_blog/posts/dependencias/
En proceso de atrapar conejo blanco... Se realizará con mermaid:
Refrencia: https://mermaid-js.github.io/mermaid/#/./integrations
La api contiene tres servicios 'GET' .
1. Servicio que consulta todos los estudiantes:
Tipo: GET
URL: http://localhost:3000/v1/students/all
Respuesta:
Te regresará el listado de todos los estudiantes que existan en tu bd.
2. Servicio que consulta los emails de todos los estudiantes que tengan certificación 'haveCertification' :
Tipo: GET
URL: http://localhost:3000/v1/students/Email/haveCertification
Respuesta:
3. Servicio que consulta los emails de todos los estudiantes que tengan creditos mayores a 500:
Tipo: GET
URL: http://localhost:3000/v1/students/credits
Respuesta:
Inicializar pproyecto npm init / intala el package.json
Instalar Jest para pruebas unitarias npm install --save-dev jest
Crear .gitignore para no versional el node module, agregar la siguiente línea: **/node_modules, node mudules nunca se debe versionar.
Se crea archivo principal del proyecto (index.js) y de agrega en package.json la referencia "start": "node index.js", para poder usar el comando npm start , y ais correr todo lo qye contenta este archivo.
Se instala server express => npm install express --save y se cre aun archivo en el que pondremos lao servicios y el puerto.
Se instala linter:
Instalar ESLint en tu proyecto npm install eslint --save-dev
Ejecuta el comando para generar la configuración del linter: npm init @eslint/config
Al finalizar esto te creará un archivo .eslintrc.js con la configuración del linter.
Se agrega configuración, haz que tu archivo .eslintrc.js se parezca a este:
Automatizawr los comandos de eslint en tu package.json (recuerda que la ruta dentro de node_modules puede variar en windows)
npm run linter - se ejecuta para revisar npm run linter-fix - se ejecuta para corregir
Agregar action github, para cada push revisar pruebas unitarias
u_Para solucionar el error => npm install [email protected] --save_
Ruta: github/workflows/test.yml
name: Run Tests in my project every push on GitHub
Bases principales:
by @CarloGilmar
Todo este proyecto fue realizado durante la misión BackEnd de LunchX, comandada y guiada por MC Carlo Gilmar
Tiempo en resolver> 4horas y 40minutos