Projeto Store Manager

Contexto

Este projeto consiste em uma API completamente RESTful para gerenciamento de vendas, utilizando Node, Express, Javascript, e MySQL, seguindo a arquitetura em camadas MSC. Nessa aplicação é possível fazer um CRUD, criar, visualizar, deletar e atualizar produtos e vendas. Além disso, ela possui uma boa cobertura de teste utilizando mocha, chai e sinon e a documentação é feita com o swagger

Rode o projeto localmente

⚠️ É preciso ter o Node instalado em sua máquina.

⚠️ É preciso criar um arquivo .env na raiz do projeto, siga o exemplo do arquivo env.example.

1. Clone o repositório:

git clone [email protected]:mairess/project-store-manager.git

2. Instale as dependências:

npm install

3. Inicie o banco de dados:

docker compose up -d db

4. Inicie o server:

env $(cat .env) npm run dev:local

5. O servidor estará disponível na porta 3001

Rode o projeto com o docker

⚠️ É preciso ter o Docker instalado em sua máquina.

1. Clone o repositório:

git clone [email protected]:mairess/project-store-manager.git

2. Suba os containers:

docker compose up -d

3. O servidor estará disponível na porta 3001

Rode os testes

Rode os testes com:

npm run test:mocha

Rode a cobertura:

npm run test:coverage

Rode a cobertura de mutação:

npm run test:coverage

Documentação da API

A documentação desta api está disponível em /api-docs

Tecnologias utilizadas

• Javascript
• Node
• Express
• MySQL
• Joi
• Docker
• swagger-ui
• Mocha
• Chai
• Sinon