AppCivico / libre-api

9 stars 0 forks source link

Documentação e Como Funciona #2

Open uira opened 7 years ago

uira commented 7 years ago

Já existe alguma documentação, pelo menos com o stack do projeto?

everton137 commented 7 years ago

Boa pergunta e pedido.

renatocron commented 7 years ago

Olá,

Bom, se for no geral, não sei onde tem um lugar publico com toda a doc do projeto.

Como funciona, referente ao fluxo do dinheiro (da captura até o deposito em conta da mídia¹):

  1. O dinheiro é capturado no cartão de crédito mensalmente (período do plano)
  2. Em 30 dias corridos, um ciclo é fechado e o valor de cada libre que o usuário deu será calculado.
  3. Assim que houver dinheiro na conta do picpay, as transferências com a somatória do valor dos libres recebidos é enviado para a conta da mídia, em ordem dos ciclos mais antigos para os mais novos.
  4. Para ter dinheiro na conta do picpay, é necessário a ação manual de deposito na conta corrente e envio do comprovante para eles. Estamos atualmente fazendo isso 2x ao mês. O dinheiro capturado do cartão é depositado em D30+1 dia util.

Agora, para tudo isso funcionar, é necessário:

¹ pode ser um jornalista ou qualquer outra pessoa física.

Agora sobre o deploy em si, precisamos documentar, mas as instruções básicas estão no docker/Dockerfile e para fazer o build existe um arquivo build-container.sh, porém, há muitas chaves/configurações necessárias para rodar o projeto como um fork/produção.

Os códigos deste repositório rodam com mock na hora de fazer a comunicação com esses serviços externos, e precisam ser adaptados para rodar em cada ambiente.

Se vocês tiverem alguma duvida, ou interesse em subir uma própria instancia, tentaremos ajudar!