/project-trybe-futebol-clube

Site informativo sobre partidas e classificações de futebol. Realizado utilizando Docker, MySQL, Sequelize, NodeJS e Typescript.

Primary LanguageJavaScript

⚽ TFC - Trybe Futebol Clube! ⚽

Logo TFC

Índice

- Contexto

- Técnologias utilizadas

- Desenvolvimento

- Como executar o projeto

Contexto

O TFC foi desenvolvido para ser um site informativo sobre partidas e classificações de futebol!

Esse projeto foi desenvolvido durante o curso da Trybe com o objetivo de treinar e consolidar os estudos de Docker, MySQL, Sequelize, Typescript, NodeJS, Express, MSC, POO e testes de integração em back-end, foi realizado em Junho de 2022, durante o módulo de Back-end.

Neste projeto sou o autor de todo Back-end da aplicação, sendo o Front-end desenvolvido pela escola Trybe.

Técnologias utilizadas

  • Docker
  • MySQL e Sequelize
  • Typescript
  • NodeJS
  • Express
  • API Rest - CRUD
  • Modelo de camadas MSC e POO
  • Testes de integração - Mocha, chai e sinon

Desenvolvimento

Neste projeto pude implementar todo o back-end (./app/backend) da aplicação TFC, de modo que o usuário possa ver a tabela atualizada e também o resultado de cada jogo.

Para o usuário do administrador é possível adicionar mais partidas, atualizando automaticamente a tabela.

Foi utilizado o docker-compose com o papel de unir todas as partes e subir um projeto completo.

Banco de dados criado em MySQL, utilizando a ferramenta Sequelize. Foram adicionados dados por via de Seeders para popular a tabela e mostrar o funcionamento.

O Back-end foi desenvolvido utilizando NodeJS, Typescript e Express. Implementando regras de negócio para popular adequadamente a tabela disponível no front-end que será exibida para a pessoa usuária do sistema.

TFC Home page

Como executar o projeto

  1. Clone o repositório * git clone https://github.com/gustavo-pd/project-trybe-futebol-clube.git. * Entre na pasta do repositório que você acabou de clonar:
    • cd project-trybe-futebol-clube

  1. Instale as dependências: * npm install

  1. Rode o Docker para unir e subir todas as partes: * npm run compose:up para upar ou npm run compose:down para derrubar

  1. O front-end irá rodar na porta 3000, e o back-end na porta 3001, para acessar o front-end, acesse no seu navegador:
  • front-end: http://localhost:3000 ou
  • back-end: http://localhost:3001

  1. Para fazer login com o admin e poder gerenciar partidas:
  • Login: admin@admin.com Password: secret_admin

Para fazer login como usuário:

  • Login: user@user.com Password: secret_user



Na sua máquina você deve ter:

  • Sistema Operacional Distribuição Unix
  • Node versão 16
  • Docker
  • Docker-compose versão 1.29.2

➡️ O node deve ter versão igual ou superior à 16.15.0 LTS. * Para instalar o nvm, acesse esse link; *Rode os comandos abaixo para instalar a versão correta de node e usá-la: * nvm install 16 --lts * nvm use 16 * nvm alias default 16

➡️ Odocker-compose deve ter versão igual ou superior àˆ1.29.2: * Use esse link de referência para realizar a instalação corretamente no ubuntu; * Acesse o [link da documentação oficial com passos para desinstalar] (https://docs.docker.com/compose/install/#uninstallation) caso necessário.