Sobre   |    Tecnologias   |    Recursos   |    Iniciando o Projeto   |    Testes   |    Contribuindo   |    Autores

🤔 Sobre

O PROJ3CT é um software de processamento Backend, que fornece APIs para...

🚀 Tecnologias

Esse projeto foi desenvolvido com as seguintes tecnologias:

General:

• fastAPI
• SQLAlchemy
• uvicorn
• python-decouple

✨ Recursos Disponiveis

Os recursos disponíveis da aplicação podem ser encontrados no swagger

🏃 Iniciando o Projeto

Sem Docker 🖥️

Para iniciar essa aplicação sem o docker, você irá precisar de python, virtualenv instalados no seu computador.

  # Crie o python environment

  $ make virtualenv

  # Ative o environment

  $ source env/bin/activate

  # Instale as dependências

  $ make install

  # Inicie a aplicação

  $ make run

  # Para desativar a máquina virtual python (virtualenv):

  $ deactivate

Com Docker 🐳

Para iniciar essa aplicação com docker, siga as instruções de instalação, em seguida utilize o comando:

  $ make compose-up

🚨 Tests

Rodando os Testes ✅

  ## Para rodar os testes unitários

  $ make test

Desenvolvendo com Testes 🔥

O time utiliza a metologia TDD para implementação de novas funcionalidades, caso não possua conhecimento, é recomendável a leitura do artigo citado.

💁🏻 Contribuindo

1. Clone o projeto:
2. Crie sua feature/fix branch seguindo o padrão e faça suas modificações:

  # Os números são obtidos na plataforma GENTI

  # feature/número da tarefa
  # fix/número do fix
  # Exemplo tarefa 103574 no GENTI

  $ git checkout -b feature/103574

3. Caso necessário versione a aplicação e adicione as informações no arquivo CHANGELOG. Nós utilizamos Semver para versionamento, para verificar as versões disponíveis visualize as tags neste respositório;

  # Script encontrado na raiz do projeto para versionamento.
  # Options: [major, minor, fix & dev] [-b "descrição do release"]

  $ ./create_release.sh option

4. Formate os arquivos:

  ## Para formatar os arquivos

  $ make format

5. Commit suas modificações:

  # Padrão seguido (message downcase):
  #
  # feat: a new feature
  # fix: a bug fix
  # docs: documentation only changes
  # style: changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  # refactor: a code change that neither fixes a bug nor adds a feature
  # perf: a code change that improves performance
  # test: adding missing or correcting existing tests
  # support: changes to the build process or auxiliary tools and libraries such
  # as documentation generation or continous integration configuration

  $ git commit -m 'feat: insert your message'

6. Push para a branch:

  $ git push origin feature/103574

7. Realize um pull request :D
8. Realize um merge local na branch master com as suas alterações, e em seguida a delete.

  $ git checkout master
  $ git merge feature/103574
  $ git branch -d feature/103574

✍️ Autores

Melo Brothers