Bem vindo ao Trybe Futebol Clube!
Esse projeto é uma API RESTfull na qual utiliza arquitetura MSC(model, Service, Controller) para ler,filtrar e criar partidas de futebol,times e tabelas de ranking. Desenvolvido na Trybe com uso de TypeScript, Node Js, Sequelize, Express e outras stacks.
Sumário
- Bem vindo ao Trybe Futebol Clube project!
- Sumário
- Contexto
- Tecnologias, bibliotecas e arquiteturas usadas
- Instruções da aplicação
Contexto
Esse Projeto é um site informativo sobre partidas e classificações dos times de futebol.Para essa aplicação foi criado uma RESTfull API que se conecta ao banco de dados MySQL via Sequelize, ao qual faz as ações de ler, modificar, filtrar e criar partidas, usuarios e times de futebol.
Tecnologias, bibliotecas e arquiteturas usadas
- TypeScript | Tipagem de variáveis.
- Node.js, Express, Nodemon | Criação de protocolo HTTP API, Roteador de API, improve API development.
- Sequelize | Mapeamento de objetos.
- Jwt | Autenticação e criação de tokens.
- bcrypt | Encriptador de senhas.
- MySQL | Criação e gerenciamento de dados.
- MSC | Arquiterura model, service, controller.
- REST | Arquitetura Rest.
- POO | Programação orientada a objetos.
- SOLID | Principios de design SOLID
- mocha, chai, Sinon | Criação de testes,Stubs e mocks
Instruções da aplicação
Instalar dependências
cd Trybe-Futebol-Clube
npm install
Rodar aplicação sem Docker
Crie um arquivo .env
com sua conexão ao MySQL.
cd Trybe-Futebol-Clube
npm run debug
Rodando aplicação com Docker (arquivo docker-compose foi criado pela Trybe)
cd app
docker-compose up -d
Rodando aplicação back-end com Docker (arquivo docker-compose foi criado pela Trybe)
cd backend
npm run dev
Rodando aplicação front-end com Docker (arquivo docker-compose foi criado pela Trybe)
obs: front-end desenvolvido pela trybe
cd frontend
npm start
Rodar Lint
npm run lint
Rodar tests
cd backend
npm run test
Dando login de usuario
exemplo:
email: [email protected] , senha: secret_admin