Projeto Trybe Futebol Clube

Statements	Branches	Functions	Lines

Contexto

Este é um projeto full e consiste em um website informativo sobre partidas e classificações de futebol, onde o frontend foi disponibilizado pela Trybe. Minha responsabilidade foi desenvolver o backend utilizando o método TDD além da integração das aplicações via docker-compose e teste de integração.

Rode o projeto localmente

⚠️ É preciso ter o Node instalado em sua máquina.

⚠️ É preciso usar a versão 16 do Node, rode nvm use 16.

⚠️ Caso não tenha o nvm instalado, siga a orientação de instalação no link e use a versão 16.

1. Clone o repositório:

git clone [email protected]:mairess/project-trybe-futebol-clube.git

2. Instale as dependências:

npm run install:apps

3. Inicie o container do banco de dados:

npm run compose:db

4. Inicie os servidores:

npm run start:servers

5. O servidor back estará disponível na porta 3001 e o front na porta 3000

Rode o projeto com o docker

⚠️ É preciso ter o Docker instalado em sua máquina.

1. Clone o repositório:

git clone [email protected]:mairess/project-trybe-futebol-clube.git

2. Suba os containers:

npm run compose:up

3. O servidor back estará disponível na porta 3001 e o front na porta 3000

Rode os testes

Rode os testes:

npm test

Rode a cobertura:

npm run test:coverage

Documentação da API

A documentação desta api está disponível na rota /api-docs

Tecnologias utilizadas

• Typescript
• Node
• Express
• Sequelize
• MySQL
• JWT
• Bcrypt
• Joi
• Docker
• Mocha
• Chai
• Sinon
• Swagger-ui