Cashback Boticario

Sistema de cashback para compra de revendedoras.

Documentação da API

  GET /docs

  GET /redoc

Pré requisito

• Pyenv

• Poetry

• Docker

• Docker Compose

• Instalar pacotes essenciais (Ubuntu/Debian)

    sudo apt-get update && apt-get install -y make curl build-essential

Rodando em ambiente de desenvolvimento

Clone o projeto

  git clone https://github.com/anaplopes/cashback.git

Entre no diretório do projeto

  cd cashback

Preparando o ambiente

  make prepare

Instale as dependências

  make install

Adicione as variaveis de ambiente no arquivo .env.dev:

• DEBUG=True (se não definida o sistema usara False como valor padrão)
• ENVIRONMENT="dev" (se não definida o sistema usara dev como valor padrão)
• DB_URI="postgresql://{DB_USER}:{DB_PASSWORD}@localhost:5432/{DB_NAME}"
• GB_API_URL=url da API Grupo Boticario
• GB_TOKEN=token da API Grupo Boticario

Inicie o container do banco de dados

  make up-db

Inicie o servidor

  make run-server

Para rodar os testes, rode o seguinte comando

  make test

Rodando no docker

Adicione as variaveis de ambiente no arquivo .env.prod

• Obrigatório

  • DEBUG=False (se não definida o sistema usara False como valor padrão)
  • ENVIRONMENT="prod" (se não definida o sistema usara dev como valor padrão)
  • DB_URI="postgresql://{DB_USER}:{DB_PASSWORD}@db:5432/{DB_NAME}"
  • GB_API_URL=url da API Grupo Boticario
  • GB_TOKEN=token da API Grupo Boticario

• Opcional (***Essa mudança afetará a configuração DB_URI nos arquivos .env.*)

  • DB_USER=usuario do banco de dados
  • DB_PASSWORD=senha do banco de dados
  • DB_NAME=nome do banco de dados

Inicie todos os containers

  make up

Parar os containers

  make down

Limpar o docker

  make clean