profit-sharing-api

API para calculo de Participação de lucros

Este repositório contém o código fontedo projeto de API para cálculo de participação de lucro.

Estrutura

O repositório está distribuído em diferentes pastas para melhor organização, segue abaixo descrição das pastas:

• profit_calc: contém um pacote reutilizavél do motor de regras e o calculo de distribuição;
• dj_stone_profit_sharing_api: contém uma aplicação completa de API Rest + Persistência feita principalmente com Django + DRF.

Cada pasta possui internamente maiores detalhes de funcionamento.

Para executar a aplicação (para os apressados)

Start

1. Instalar docker
2. Instalar docker-compose
3. Entrar na pasta dj_stone_profit_sharing_api
4. Levantar serviços
   1. docker-compose -f local.yml up -d
5. Criar usuário
   1. docker-compose -f local.yml run django python manage.py createsuperuser
   2. Preencher as informações do usuário
6. Acessar a documentação da API em http://localhost:8000/swagger