Bem-vindo ao Happy Originação, o seu lugar para tudo relacionado a cartões consignados e portabilidade. Estamos entusiasmados por tê-lo conosco na nossa jornada!

1. Introdução
2. Requisitos Básicos
3. Instalação dos Requisitos
4. Clonando o Repositório
5. Local Settings
6. Diretórios do Projeto
7. Requirements
8. APIs no Postman
9. Padrão de código
10. Contribuidores

Bem-vindo ao Happy Originação, um sistema de gerenciamento focado em soluções para cartão consignado e portabilidade (por enquanto).

Aqui, no Happy Originação, trabalhamos para tornar a gestão dos nossos produtos a mais tranquila possível. Nosso sistema visa facilitar o trabalho dos gestores, fornecendo todas as ferramentas necessárias para uma administração eficiente.

Seja você um desenvolvedor veterano ou um recém-chegado à nossa equipe, estamos felizes em tê-lo conosco. Esta documentação visa guiá-lo em todas as etapas necessárias para configurar e entender nosso projeto.

Vamos começar!

Para rodar este projeto, você precisará ter instalado:

• Python
• IDE (preferencialmente PyCharm)
• Git Bash
• MySQL

Este é um guia básico sobre como instalar os requisitos:

1. Python: Você pode baixar o Python do site oficial aqui.
2. PyCharm: Baixe e instale o PyCharm da JetBrains aqui.
3. Git Bash: O Git Bash pode ser baixado e instalado a partir deste link.
4. MySQL: Você pode baixar o MySQL aqui.

Para clonar o repositório, você pode seguir os passos abaixo:

Com o git Bash instalado e configurado clone o repositorio abra o Git Bash/terminal/cmd e execute o seguinte comando: git clone https://github.com/byxcapital/originacao-backend

O arquivo .env.develop permite personalizar as configurações do ambiente de desenvolvimento. Para rodar o projeto, criei uma cópia do arquivo .env.develop e renomeie para .env, assim o seu projeto terá as variáveis de ambiente necessárias para rodar na sua máquina. O arquivo .env não é versionado, assim você pode testar diferentes valores para as variáveis de ambiente.

Sempre que uma nova variável de ambiente for adicionada, além de incluir no seu arquivo .env, você deve incluir no arquivo .env.develop, assim qualquer desenvolvedor vai conseguir rodar o projeto com essa nova variável de ambiente. Além disso, você deve carregar essa variável no arquivo settings.py, para que o projeto tenha esse novo valor. Para adicionar uma nova variável de ambiente no projeto, seguir os passos abaixo:

• Adicione a variável no arquivo .env:

  CHAVE_STRING="STRING"
  CHAVE_INT=1234
  CHAVE_BOOL=True
  CHAVE_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----\nhdkaadjsl...\ndhasdhasH\n-----END PRIVATE KEY-----"
  

• Adicione a variável no arquivo settings.py para que o projeto enxergue a nova variável:

  from decouple import config (caso não tenha importado ainda)
  
  CHAVE_STRING = config('CHAVE_STRING')
  CHAVE_INT = config('CHAVE_INT', cast=int)
  CHAVE_BOOL = config('CHAVE_BOOL', default=False, cast=bool)
  CHAVE_PRIVATE_KEY = config('CHAVE_PRIVATE_KEY').replace('\\n', '\n')
  

• Use a variável em qualquer arquivo do projeto:

  from django.conf import settings (caso não tenha importado ainda)
  
  url = f'{settings.CHAVE_STRING}/rota-api'
  
  soma_limite = settings.CHAVE_INT + 1
  
  if settings.CHAVE_BOOL:
      func()
  
  chave_autenticaçao = pegar_chave_autenticacao(settings.CHAVE_PRIVATE_KEY)
  

Configurações do Amazon S3

O projeto utiliza o Amazon S3 para armazenamento de documentos. Os nomes dos buckets são:

• BUCKET_NAME_AMIGOZ: "documentos-clientes-amigoz"
• BUCKET_NAME_PORTABILIDADE: "documentos-clientes-portabilidade"
• BUCKET_NAME_INSS: "documentos-cliente-inss"
• BUCKET_NAME_TERMOS: "termos-amigoz"

Configurando AWS CLI

Para configurar o AWS CLI em seu computador, siga os passos abaixo:

1. Baixe e instale o AWS CLI de acordo com o seu sistema operacional: https://aws.amazon.com/cli/
2. Abra o terminal e execute o comando aws configure.
3. Insira as chaves de acesso (Access Key ID e Secret Access Key) fornecidas pelo time.
4. Defina a região padrão e o formato de saída, se necessário.

O projeto utiliza o banco de dados MySQL. As configurações são as seguintes:

• ENGINE: django.db.backends.mysql
• NAME: {nome_do_banco}
• USER: {seu_user}
• PASSWORD: {sua_senha}
• HOST: localhost
• PORT: (vazio)
• OPTIONS: {'charset': 'utf8', 'use_unicode': True}

DATABASES = { 'default': { 'ENGINE': 'django.db.backends.mysql', 'NAME': 'originacao', 'USER': 'nome_usuario_banco', 'PASSWORD': 'senha_banco', 'HOST': 'localhost', 'PORT': '', 'OPTIONS': { 'charset': 'utf8', 'use_unicode': True, }, }, }

LOGGING = { 'version': 1, 'disable_existing_loggers': False, 'formatters': { 'base': { 'format': '{name} ({levelname}) :: {message}', 'style': '{' } }, 'handlers': { 'console': { 'class': 'logging.StreamHandler', 'formatter': 'base' }, 'logtail': { 'class': 'logtail.LogtailHandler', 'formatter': 'base', 'source_token': 'Nz2rhiECTufK5UaGH9NmQJfB' }, }, 'loggers': { 'digitacao': { 'handlers': ['console', 'logtail'], 'level': 'INFO' }, 'cliente': { 'handlers': ['console', 'logtail'], 'level': 'INFO' }, 'webhookqitech': { 'handlers': ['console', 'logtail'], 'level': 'INFO' }, 'celery': { 'handlers': ['console', 'logtail'], 'level': 'INFO', 'propagate': False, }, } }

• 📂 .github - Contém arquivos específicos do GitHub, como workflows do GitHub Actions.
• 📂 api_log - Contém os logs gerados pela API do projeto.
• 📂 auditoria - Utilizado para recursos de auditoria, contendo logs de auditoria ou código relacionado à auditoria.
• 📂 contract - Contém informações ou código relacionado a contratos e aos nossos produtos.
• 📂 core - Contem codigos do cliente e codigos que são comuns a todos os produtos.
• 📂 credentials - Contém arquivos de credenciais usados pelo projeto, como chaves privadas.
• 📂 custom auth - Contém código personalizado para autenticação no aplicativo.
• 📂 handlers - Contém manipuladores para diferentes eventos ou erros que o aplicativo pode encontrar.
• 📂 static - Diretório para arquivos estáticos, como CSS, JavaScript ou imagens usadas pelo aplicativo.
• 📂 templates - Contém templates, para páginas HTML se o projeto for um aplicativo da web.

Os requirements do projeto estão listados no arquivo requirements.txt. Você pode instalar todos os requirements com o comando pip install -r requirements.txt.

Todas as APIs do projeto estão disponíveis no Postman. Para acessá-las, importe a coleção fornecida pelo time. Para fazer isso, siga os passos abaixo:

1. Abra o Postman.
2. Clique no ícone de "Import" no canto superior esquerdo da janela.
3. Selecione a opção "Import From Link" ou "Upload Files", dependendo de como a coleção foi compartilhada com você.
   • Se for um link, cole o link da coleção e clique em "Import".
   • Se for um arquivo, navegue até o local do arquivo e selecione-o para importar.
4. Após a importação, a coleção aparecerá no painel esquerdo do Postman, na seção "Collections".
5. Clique na coleção importada para expandi-la e ver todas as APIs disponíveis.
6. Selecione a API desejada e insira os parâmetros necessários, se aplicável, antes de enviar a solicitação.

Agora você está pronto para testar e explorar todas as APIs do projeto utilizando o Postman.

Para padronizar o código do projeto, utilizamos a ferramenta "pre-commit" para organizar e formatar com um padrão pré estipulado. A instalação e utilização é sem simples, sendo quase tudo ajustado automaticamente pela ferramenta, podendo ficar apenas alguns pequenos ajustes. Para instalar e utilizar o "pre-commit":

1. Abra o terminal e rode o comando para instalar as dependências de dev:

    pip install -r dev-requirements.txt

2. Rode o comando abaixo para instalar os hooks do "pre-commit" na sua pasta ".git":

    pre-commit install

3. Após isso, é só fazer um commit que a ferramenta vai analisar os arquivos dentro do commit e fazer os ajustes conforme o padrão do projeto, e apontar os problemas que a ferramenta não conseguir ajustar automaticamente.
4. Se não tiver nada fora do padrão, o seu commit será realizado.
5. (Opcional): Se você quiser acelerar o processo, instale no seu editor de código as extensões do Flake8 e do Black, que o editor de código vai apontar os ajustes que serão feitos automaticamente.

Obs: Usuários de Windows que se depararam com o erro RuntimeError: no .dist-info at podem resolver com uma das duas possibilidades abaixo:

1. Excluir a pasta virtualenv que o erro vai apontar. Normalmente será algo parecido com: C:\Users\<Nome_Usuario>\AppData\Local\Packages\PythonSoftwareFoundation.Python.<versao_python>_qbz5n2kfra8p0\LocalCache\Local\pypa\virtualenv.
2. Habilitar caminhos longos no Windows: https://superuser.com/questions/1119883/windows-10-enable-ntfs-long-paths-policy-option-missing

Agradecemos a todos que contribuíram para este projeto.