Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mairess/project-trybe-futebol-clube
App sobre partidas de futebol. Feita com typescript, node, express, sequelize, mysql, testada com mocha, chai e sinon, orquestrada com docker-compose e documentada com swagger-ui-express.
https://github.com/mairess/project-trybe-futebol-clube
chai docker express joi jwt mocha mysql node sequelize sinon swagger-ui-express tdd typescript
Last synced: about 1 month ago
JSON representation
App sobre partidas de futebol. Feita com typescript, node, express, sequelize, mysql, testada com mocha, chai e sinon, orquestrada com docker-compose e documentada com swagger-ui-express.
- Host: GitHub
- URL: https://github.com/mairess/project-trybe-futebol-clube
- Owner: mairess
- Created: 2024-03-15T20:29:11.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-04-19T15:06:53.000Z (7 months ago)
- Last Synced: 2024-10-01T05:16:13.744Z (about 2 months ago)
- Topics: chai, docker, express, joi, jwt, mocha, mysql, node, sequelize, sinon, swagger-ui-express, tdd, typescript
- Language: TypeScript
- Homepage:
- Size: 704 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
#
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](https://nodejs.org/en) instalado em sua máquina.
>
> ⚠️ É preciso usar a versão 16 do [Node](https://nodejs.org/en), rode `nvm use` 16.
>
> ⚠️ Caso não tenha o nvm instalado, siga a orientação de instalação no [link](https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-and-updating) e use a versão 16.
>
>
1. Clone o repositório:
```BASH
git clone [email protected]:mairess/project-trybe-futebol-clube.git
```
2. Instale as dependências:
```BASH
npm run install:apps
```
3. Inicie o container do banco de dados:
```BASH
npm run compose:db
```
4. Inicie os servidores:
```BASH
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](https://www.docker.com/get-started/) instalado em sua máquina.
1. Clone o repositório:
```BASH
git clone [email protected]:mairess/project-trybe-futebol-clube.git
```
2. Suba os containers:
```BASH
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:
```SHELL
npm test
```
Rode a cobertura:
```SHELL
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