https://github.com/imsamuelcovalero/project-trybe-futebol-clube
https://github.com/imsamuelcovalero/project-trybe-futebol-clube
backend bcryptjs controller cors crud docker express express-async-errors joi-validation jwt-authentication mocha-chai model nodejs nodemon rest-api sequelize service sinon sql typescript
Last synced: 25 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/imsamuelcovalero/project-trybe-futebol-clube
- Owner: imsamuelcovalero
- Created: 2022-10-03T12:37:06.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-22T02:31:00.000Z (over 2 years ago)
- Last Synced: 2024-04-16T08:49:42.436Z (about 1 year ago)
- Topics: backend, bcryptjs, controller, cors, crud, docker, express, express-async-errors, joi-validation, jwt-authentication, mocha-chai, model, nodejs, nodemon, rest-api, sequelize, service, sinon, sql, typescript
- Language: TypeScript
- Homepage:
- Size: 907 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Project Trybe Futebol Clube
# Contexto
No projeto de backend da Trybe, Trybe Futebol Clube, restaurei o backend de uma aplicação fullstack de campeonato brasileiro de futebol. Através de CRUDs é possível fazer login, consultar times e partidas, inserir, editar e/ou finalizar partidas. Também é possível consultar a tabela de classificação dos times, dentro de casa, fora de casa e geral. Realizei testes de integração que cobriram mais de 80% das linhas de código. Como padrão de organização de camadas foi utilizado o MSC (Model, Service e Controller), o que contribuiu para a API ser REST; os conceitos de SOLID também foram implementados. Os erros foram tratados de maneira customizada e os commits estão no padrão convencional.
## Tecnologias usadas
Back-end:
> Desenvolvido usando: NodeJS, Express, Docker, Typescript, POO, Sequelize, SQL, JWT e Joi.
## Instalando Dependências
> Na raíz do projeto
```bash
cd project-Trybe-Futebol-Clube
npm install
```
## Executando aplicação em docker
* Deve ser executado o compose para subir os containers de backend, frontend e o banco de dados:
```
docker-compose up -d
*A aplicação frontend estará rodando na porta 3000: http://localhost:3000/ do navegador
e as requisições HTTP podem ser feitas na porta 3001: http://localhost:3001/ através do Insomnia, Postman ou outro API client.
```
* Para fazer as requisições e visualizar os logs:
```
Instale as dependências dentro do backend
Execute o comando para acessar o terminal do docker: docker exec -it app_backend sh
Instale as dependências dentro do docker: npm install
O nodemon estará rodando junto com o docker compose, e é possível visualizar os logs do container pelo Docker-desktop
ou extensão do Docker no VS Code
```