Skip to content

Latest commit

 

History

History
97 lines (65 loc) · 4.18 KB

README_es.md

File metadata and controls

97 lines (65 loc) · 4.18 KB

Node Logo Trybe Futebol Clube Node Logo

🌐 Português Español English Русский 中文 العربية

Vista previa de la aplicación

📄 Descripción

Trybe Futebol Clube es una aplicación de gestión de partidos de fútbol desarrollada como parte del módulo de Backend del curso de Desarrollo Web de Trybe. Este proyecto permite a los usuarios gestionar partidos, equipos y líderes de forma simple y eficiente, utilizando un backend robusto y dockerizado.

✨ Funcionalidades
  • Gestión de Partidos: Creación, actualización y finalización de partidos en curso.
  • Gestión de Equipos: Registro y manipulación de información sobre equipos de fútbol.
  • Sistema de Login: Autenticación de usuarios para garantizar la seguridad y la integridad de los datos.
  • Clasificación: Obtención de información sobre la clasificación de los equipos en un formato fácil de entender.

🛠️ Tecnologías Utilizadas
  • Node.js: Entorno de ejecución para JavaScript en el lado del servidor.
  • Express: Framework para construir APIs RESTful.
  • Sequelize: ORM (Object-Relational Mapping) para manipulación de bases de datos.
  • Docker: Para la contenedorización de la aplicación, facilitando la configuración y la gestión de dependencias.
  • TypeScript: Para tipado estático, aumentando la calidad y el mantenimiento del código.

📑 Estructura de Rutas

La API tiene las siguientes rutas:

  • Equipos

    • GET /teams: Recupera todos los equipos.
    • POST /teams: Crea un nuevo equipo.

  • Login

    • POST /login: Realiza la autenticación del usuario.

  • Partidos

    • GET /matches: Recupera todos los partidos.
    • POST /matches: Crea un nuevo partido.
    • PATCH /matches/:id: Actualiza un partido en curso.
    • PATCH /matches/:id/finish: Finaliza un partido en curso.

  • Clasificación

    • GET /leaderboard: Recupera la clasificación de los equipos.

🚀 Instalación

  1. Clona el repositorio:

    git clone [email protected]:SamuelRocha91/trybeFutebolClube.git
cd trybe-futebol-clube

  2. Instala las dependencias:

    npm install

  3. Configura Docker:

    • Asegúrate de que Docker esté instalado y en funcionamiento en tu máquina.
    • Puedes usar docker-compose para inicializar los servicios necesarios.

  4. Para ejecutar la aplicación, usa el comando:

    cd app
docker-compose up --build

    La aplicación se iniciará en el puerto especificado por la variable de entorno APP_PORT, con un valor predeterminado de 3001.

🔗 Repositorios Relacionados