Academy API REST

Contenido 📝

1. Objetivo
2. Sobre el proyecto
3. Deploy
4. Stack
5. Diagrama
6. Instalación
7. Endpoints
8. Futuras funcionalidades
9. Contribuciones
10. Licencia
11. Webgrafia
12. Desarrollo
13. Agradecimientos
14. Contacto

Objetivo

Este proyecto requería una API funcional conectada a una base de datos con al menos una relación de uno a muchos y una relación de muchos a muchos.

Sobre el proyecto

Decidí crear una aplicación web para ayudar a los amantes del gimnasio, que les permitiría crear y realizar un seguimiento de nuevas rutinas para sus ejercicios diarios. He visto muchas apps de este estilo pero ninguna que nos permita cambiar tan libremente las rutinas adaptandolas a nuestras necesidades.

Deploy 🚀

Url a producción 🚀🚀🚀

Stack

Tecnologías utilizadas:

Diagrama BD

Instalación en local

1. Clonar el repositorio
2. $ npm install
3. Conectamos nuestro repositorio con la base de datos
4. $ Ejecutamos las migraciones
5. $ Ejecutamos los seeders
6. $ npm run dev
7. ...

Endpoints

Endpoints

• AUTH

  • REGISTER

      POST http://localhost:3000/api/register
    

    body:

        {
            "user": "David",
            "email": "[email protected]",
            "password": "princes"
        }

  • LOGIN

      POST http://localhost:3000/api/login  
    

    body:

        {
            "user": "David",
            "email": "[email protected]",
            "password": "princes"
        }

• RUTINAS

  • RECUPERAR RUTINAS

      GET http://localhost:3000/api/rutina
    

  • ...

Futuras funcionalidades

[ ] Añadir create book
[ ] Añadir logs con winston
[ ] Validaciones de la solicitud con express-validator
[ ] ...

Contribuciones

Las sugerencias y aportaciones son siempre bienvenidas.

Puedes hacerlo de dos maneras:

1. Abriendo una issue
2. Crea un fork del repositorio
   • Crea una nueva rama

     $ git checkout -b feature/nombreUsuario-mejora
     

   • Haz un commit con tus cambios

     $ git commit -m 'feat: mejora X cosa'
     

   • Haz push a la rama

     $ git push origin feature/nombreUsuario-mejora
     

   • Abre una solicitud de Pull Request

Licencia

Este proyecto se encuentra bajo licencia de "Mi Nombre"

Webgrafia:

Para conseguir mi objetivo he recopilado información de:

• link a repositorios
• link a documentacion de librerias externas
• ...

Desarrollo:

 const developer = "datata";

 console.log("Desarrollado por: " + datata);

Agradecimientos:

Agradezco a mis compañeros el tiempo dedicado a este proyecto:

• Jose
  

• David
  

• Mara
  

Contacto