https://github.com/samuelrocha91/trybefutebolclube

A aplicação consiste num site gerenciador de um sistema de jogos de futebol através de um backend dockerizado e modelado com Sequelize
https://github.com/samuelrocha91/trybefutebolclube

docker express sequelize typescript

Last synced: about 10 hours ago
JSON representation

A aplicação consiste num site gerenciador de um sistema de jogos de futebol através de um backend dockerizado e modelado com Sequelize

• Host: GitHub
• URL: https://github.com/samuelrocha91/trybefutebolclube
• Owner: SamuelRocha91
• Created: 2023-10-21T18:47:03.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-21T20:51:01.000Z (about 1 year ago)
• Last Synced: 2023-10-21T21:35:52.669Z (about 1 year ago)
• Topics: docker, express, sequelize, typescript
• Language: TypeScript
• Homepage:
• Size: 653 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
#  Trybe Futebol Clube 

## 🌐 [![Português](https://img.shields.io/badge/Português-green)](https://github.com/SamuelRocha91/trybeFutebolClube/blob/main/README.md) [![Español](https://img.shields.io/badge/Español-yellow)](https://github.com/SamuelRocha91/trybeFutebolClube/blob/main/README_es.md) [![English](https://img.shields.io/badge/English-blue)](https://github.com/SamuelRocha91/trybeFutebolClube/blob/main/README_en.md) [![Русский](https://img.shields.io/badge/Русский-lightgrey)](https://github.com/SamuelRocha91/trybeFutebolClube/blob/main/README_ru.md) [![中文](https://img.shields.io/badge/中文-red)](https://github.com/SamuelRocha91/trybeFutebolClube/blob/main/README_ch.md) [![العربية](https://img.shields.io/badge/العربية-orange)](https://github.com/SamuelRocha91/trybeFutebolClube/blob/main/README_ar.md)

![Preview da aplicação](./capturaEnpoint.png)

  
📄 Descrição


  **Trybe Futebol Clube** é uma aplicação de gerenciamento de jogos de futebol desenvolvida como parte do módulo de Backend do curso de Desenvolvimento Web da Trybe. Este projeto permite que os usuários gerenciem partidas, equipes e líderes de forma simples e eficiente, utilizando um backend robusto e dockerizado.

  
✨ Funcionalidades


  - **Gerenciamento de Partidas**: Criação, atualização e finalização de partidas em andamento.

  - **Gerenciamento de Equipes**: Registro e manipulação de informações sobre equipes de futebol.

  - **Sistema de Login**: Autenticação de usuários para garantir a segurança e a integridade dos dados.

  - **Classificação**: Obtenção de informações sobre a classificação das equipes em um formato fácil de entender.

  
🛠️ Tecnologias Utilizadas


  - **Node.js**: Ambiente de execução para JavaScript no lado do servidor.

  - **Express**: Framework para construção de APIs RESTful.

  - **Sequelize**: ORM (Object-Relational Mapping) para manipulação de bancos de dados.

  - **Docker**: Para contêinerização da aplicação, facilitando a configuração e o gerenciamento de dependências.

  - **TypeScript**: Para tipagem estática, aumentando a qualidade e a manutenção do código.

  
📑 Estrutura de Rotas


  A API possui as seguintes rotas:

  - **Equipes**

    - `GET /teams`: Recupera todas as equipes.

    - `POST /teams`: Cria uma nova equipe.

  - **Login**

    - `POST /login`: Realiza a autenticação do usuário.

  - **Partidas**

    - `GET /matches`: Recupera todas as partidas.

    - `POST /matches`: Cria uma nova partida.

    - `PATCH /matches/:id`: Atualiza uma partida em andamento.

    - `PATCH /matches/:id/finish`: Finaliza uma partida em andamento.

  - **Classificação**

    - `GET /leaderboard`: Recupera a classificação das equipes.

  
🚀 Instalação


  1. Clone o repositório:

     ```bash

     git clone [email protected]:SamuelRocha91/trybeFutebolClube.git

     cd trybe-futebol-clube

     ```

  2. Instale as dependências:

     ```bash

     npm install

     ```

  3. Configure o Docker:

     - Certifique-se de que o Docker está instalado e em execução na sua máquina.

     - Você pode usar o `docker-compose` para inicializar os serviços necessários.

  4. Para executar a aplicação, use o comando:

     ```bash

     cd app

     docker-compose up --build

     ```

     A aplicação será iniciada na porta especificada pela variável de ambiente `APP_PORT`, com um padrão para 3001.

  
🔗 Repositórios Relacionados


  - 🗡️ [Trybe Smith](https://github.com/SamuelRocha91/TrybeSmith)

  - 🪧 [Blogs Api](https://github.com/SamuelRocha91/BlogsApi)

  - 🐉 [Trybers and Dragons](https://github.com/SamuelRocha91/trybeAndDragons)