Safe House

📄 Sobre

Esse repositório contém a API Rest do nosso projeto de conclusão de curso SafeHouse. Ele foi criado com javascript e com TDD.

📑 Pré-requisitos

Para rodar o projeto local é necessário ter instalado em sua máquina

• Node v >= 12.19.0
• Docker
• docker-composer

📜 Scripts

Script	Função
npm test	Roda todos os testes
npm run prd	Roda a aplicação no modo de produção
npm run dev	Roda a aplicação em modo de desenvolvimento e sobe o container
npm run clean	Derruba o banco de dados e limpa
npm run reset	Reseta o banco de dados
npm run build	Transpila a aplicação
npm run test:staged	Roda o script da staged area do git
npm run migrate	Roda todas as migrations e seed
npm start	Apenas roda a aplicação

📦 Bibliotecas

• Sequelize
• Express
• Eslint
• Prettier
• Lint-staged
• Husky
• Jest
• Mysql
• Socket.io (Usado para criação do chat e interações em tempo real)
• Multer (Para receber as imagens)

▶️ Como rodar a api local

Para instalar as depêndencias do projeto em sua máquina rode:

$ npm i 

Para executar o projeto basta rodar o comando abaixo:

$ npm run dev

Rode as migrations

$ npx sequelize-cli db:migrate 

Para adicionar os jogos no banco de dados rode o comando

Apenas depois de rodar as migrations

$ npx sequelize db:seed:all 

Para resetar todas as tabelas do banco basta rodar

$ npm run reset

Os containers dos bancos serão criados no mesmo momento então não se preocupe

🔴 Para rodar os testes

Caso não tenha instalado as dependecias ainda execute o comando:

$ npm i 

Se já tiver feito basta executar o comando

$ npm t

👨‍💻 Colaboradores

Willian Francisco	Cristian Silva