Com o Speed Beer, a diversão não espera! Entregamos sua bebida geladinha na velocidade da sede.
SpeedBeer é um projeto fullstack de delivery de bebidas que visa oferecer para os empresários do ramo uma plataforma de vendas online para aumentar o alcance de seus negócios e facilitar o processo de venda, assim como oferecer para os clientes uma ampla variedade de bebidas em um único lugar, permitindo que eles naveguem facilmente pelo catálogo, selecionem seus produtos favoritos e façam pedidos em poucos cliques, podendo visualizar o status do pedido a qualquer momento.
⚠️ Configurações mínimas para execução do projeto
➡️ O node
deve ter versão igual ou superior à 16.14.0 LTS
:
- Para instalar o nvm, acesse esse link;
- Rode os comandos abaixo para instalar a versão correta de
node
e usá-la:nvm install 16.14 --lts
nvm use 16.14
nvm alias default 16.14
🏦 Banco de dados e Sequelize
Para o banco de dados, foi utilizado o ORM Sequelize
, que fará interface com o MySQL
com base no Diagrama ER a seguir:
🔰 Iniciando o projeto e Comandos Úteis
- Clone o repositório
git clone [email protected]:luizfilipelgs/SpeedBeer-App-Delivery-Fullstack.git
- Entre na pasta do repositório que você acabou de clonar:
cd SpeedBeer-App-Delivery-Fullstack
- Instale as dependências e rode o Sequelize.
-
npm run dev:prestart
-
dev:prestart: A partir da raiz, esse comando faz o processo de instalação de dependências (npm i) nos dois projetos (./front-end e ./back-end) e roda o Sequelize no ./back-end (lembrar de configurar o .env no mesmo);
- Inicialize o servidor.
- Dentro do projeto, vá para a pasta do back-end
cd back-end/
- Execute
npm run dev
para inicializar o servidor - Aparecerá no terminal a mensagem
Api rodando na porta 3001
- Porta Back-End - http://localhost:3001
- Inicialize a aplicação.
- Dentro do projeto, vá para a pasta do Front-end
cd front-end/
- Execute
npm start
- Uma aba será aberta em seu navegador com a aplicação rodando na porta 3000.
- Porta Front-End - http://localhost:3000
- Resetando Banco de Dados.
-
npm run db:reset
-
db:reset: Roda os scripts do Sequelize restaurando o banco de dados de desenvolvimento (final -dev). Utilize esse script caso ocorra algum problema no seu banco local;
-
npm run db:reset:debug
-
db:reset:debug: Roda os scripts do Sequelize restaurando o banco de dados de desenvolvimento (final -dev). Utilize esse script caso ocorra algum problema no seu banco local. Esse comando também é capaz de retornar informações detalhadas de erros (quando ocorrerem no processo);
🛠 Execução de testes localmente
Para executar os testes localmente, basta executar na pasta de back-end o comando npm run test:coverage
.
Você verá a lista de testes aprovados e a tabela de cobertura deles.
Para realização da documentação da API foi utilizando o Postman
, ele é um API Client que facilita aos desenvolvedores criar, compartilhar, testar e documentar APIs. Isso é feito, permitindo aos usuários criar e salvar solicitações HTTP e HTTPs simples e complexas, bem como ler suas respostas.
Para visualizar a documentação acesse: https://documenter.getpostman.com/view/26063649/2s93JutNXU