anatfernandes / le-voucher-api

API para uma pequena loja de roupas.

🎫 Le Voucher

Índice

• Sobre
• Rotas
  • Criar voucher
  • Aplicar voucher
• Como rodar em desenvolvimento
• Como rodar os testes
• Créditos

Sobre

Le Voucher é uma API para uma pequena loja de roupas que oferece duas rotas: uma para a criação de vouchers e outra para aplicação destes vouchers.
Nota: esse projeto é uma Prática de Testes Unitários.

Rotas

URL base: http://localhost:5000

Criar voucher

• Rota: /vouchers

• Método: POST

• Exemplo de Body:

  {
    "code": "123Abc",
    "discount": 20
  }

Aplicar voucher

• Rota: /vouchers/apply

• Método: POST

• Exemplo de Body:

  {
    "code": "123Abc",
    "amount": 100
  }

• Exemplo de Resposta:

  {
    "amount": 100,
    "discount": 20,
    "finalAmount": 80,
    "applied": true
  }

Como rodar em desenvolvimento

1. Clone esse repositório:

git clone https://github.com/AnaLTFernandes/le-voucher-api.git

2. Na raiz do projeto, instale as dependências:

npm install

3. Crie um banco de dados PostgreSQL com o nome que desejar

4. Configure o arquivo .env usando como base o arquivo .env.example

5. Rode as migrations para criar as tabelas no banco de dados

npm run prisma:migrate

6. Inicie o projeto:

npm run dev

7. Divirta-se nas rotas usando de URL base: http://localhost:{ENV_PORT}

Como rodar os testes

1. Siga os passos da seção Como rodar em desenvolvimento

2. Inicie os testes:

npm run test:unit

Créditos

• Código base do projeto api-le-voucher de codethi