Projeto Store Manager

Um sistema de gerenciamento de vendas no formato dropshipping em que é possível criar, visualizar, atualizar e deletar, produtos e vendas.!

Sumário

• Sobre o Projeto

• Tecnologias e Bibliotecas

• Como executar o projeto

• Dicas de scripts prontos

📃 Sobre o Projeto

Esta API RESTful é um sistema de gerenciamento de vendas no formato dropshipping em que é possível criar, visualizar, atualizar e deletar, produtos e vendas, a API foi desenvolvida dentro de containers docker utilizando um banco de dados MySQL

Você pode consultar informaçoes sobre as rotas aqui!
Você pode consultar informaçoes sobre os testes aqui!

🛠 Tecnologias e Bibliotecas utilizadas no desenvolvimento do projeto

Node.js
MySQL
Mysql2
Express
Nodemon

Veja o arquivo package.json

🚀 Como executar o projeto

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js.

É recomendado utilizar algum cliente HTTP, como Postman ou o Insomnia.

Além disto é bom ter um editor para trabalhar com o código como VSCode

1- Clonar o repositorio

git@github.com:andremarquezz/Projeto-StoreManager.git

🐳 Rodando no Docker

Com Docker

Rode o serviço node com o comando

docker-compose up -d

Esse serviço irá inicializar dois containers chamados store_manager e store_manager_db, respectivamente.
- A partir daqui você pode rodar o container via CLI ou abri-lo no VS Code.

Via CLI use o comando

docker exec -it store_manager bash

Ele te dará acesso ao terminal interativo do container store_manager(node) criado pelo compose, que está rodando em segundo plano.

Instale as dependências dentro do container com

npm install

⚠️Atenção: Caso opte por utilizar o Docker, TODOS os scripts disponíveis no package.json devem ser executados DENTRO do container, ou seja, no terminal que aparece após a execução do comando docker exec.

💻 Rodando Localmente

Instale as dependências com o comando

npm install

Para rodar o projeto desta forma, obrigatoriamente você deve ter o node instalado em seu computador.
- Recomenda-se a versão ^16

⚠️Atenção: Não esqueça de renomear/configurar o arquivo .env.example

💡 Dicas de scripts prontos

Scripts

Criar o banco de dados e gerar as tabelas:

  npm run migration

Limpar e popular o banco de dados:

  npm run seed

Iniciar o servidor Node:

  npm start

Iniciar o servidor Node com nodemon:

  npm run dev

Executar os testes de unidade:

  npm run test:mocha