Trybe Futebol Clube

Um site informativo sobre partidas e classificações de futebol

🔗 Live Site • 🔗 API • 🔗 API Docs

Tabela de conteúdos

• Sobre
• Objetivo
• Tecnologias
• Rodando localmente
  • Pré-Requisitos
  • Instalação
  • Executando

Sobre

TFC foi um projeto desenvolvido durante o curso da Trybe. Um site informativo, onde é possível criar, editar e finalizar partidas, acompanhar a classificação e também estatísticas sobre o desempenho dos times, filtrando os resultados por classificação geral, como mandante, e como visitante.

Objetivo

O objetivo do projeto foi construir o back-end, uma API RESTful, para ser consumida pelo front-end desenvolvido em React.js, que foi fornecido pronto pela Trybe.

Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

• Node.js
• Typescript
• Express
• MySQL
• Sequelize
• JWT
• Mocha, Chai & Sinon
• Docker
• Docker Compose

Essa API foi construída em Node.js utilizando o framework Express. O ORM (Object Relational Mapper) Sequelize foi utilizado para trabalhar com o banco de dados MySQL.
A autenticação no login ficou por conta do JWT (JSON Web Token), e as senhas são criptografadas usando bcrypt, salvando então apenas o hash no banco de dados. O código foi desenvolvido utilizando desenvolvimento orientado a testes (TDD), e foi conteinerizada com docker e docker-compose.

Rodando a aplicação localmente

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js, Docker, Docker-compose

Instalação

# Clone este repositório
$ git clone git@github.com:gialencar/TFC-Trybe-Futebol-Club.git

# Acesse a pasta do projeto no terminal/cmd
$ cd TFC-Trybe-Futebol-Club

Executando

# Navegue para a pasta app
$ cd app

# Execute o docker-compose
$ docker-compose up -d

# O app inciará na porta:3000 - acesse <http://localhost:3000>