danielmartins / profit-sharing-api

API para calculo de Participação de lucros

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

profit-sharing-api's Issues

Configurar pipeline para execução dos testes unitários

usar github actions

Aplicar regras de sanitização

Atualizar README com instruções

Criar ViewSets dos modelos

Configurar auto-documentação (OpenApi)

Criar cálculo de divisão diretamente proporcional

Objetivo: Dado um determinado valor, dividir proporcionalmente o valor dado uma quantidade de pesos.

Uso: A API usará este componente para realizar a distribuição proporcional.

Criar modelos para persistência dos dados dos funcionários

Criar testes unitários para os modelos

Pacote reutilizavél de cálculo

Adicionar autenticação por JWT para estágio de produção

Criar serializadores para os modelos

Melhorar documentação README

Configurar boilerplate inicial django + drf + docker