FidelizaMais

Descrição

O desafio proposto é a criação de uma API para o programa de fidelidade da Juntos Somos Mais, na qual um membro pode indicar outras pessoas para participar do programa e se aceitarem, o indicador recebe pontos para trocar por prêmios.

Intalação e Dependências

Requisitos

1. Docker
2. Docker Compose

Configurar a aplicação para rodar localmente:

Clone o repositório para criar uma cópia local no seu computador

git clone git@github.com:mairaafreitas/fideliza-mais.git

Inicialização

1. Abra o diretório clonado no terminal

2. O docker precisa preparar as imagens declaradas no repositório, criando os containers e inicializando-os, para isso, utilize o comando:

   make start

3. Para que a estrutura do banco de dados seja criada dentro do container, execute o comando:

   make migrate

4. Crie o seu usuário para acessar o painel administrativo

   make createsuperuser

5. Para verificar se está funcionando, acesse o painel administrativo

   localhost:8000/admin

6. Para rodar os testes, execute o comando:

   make test

Documentação da API

Para verificar todos os endpoints da API e seus possíveis erros, acesse:

Documentação

Para verificar como as histórias para elaboração da api foram criadas, acesse:

Kanban

Autor

• Maíra Freitas - Junior Backend Developer