O PROJ3CT é um software de processamento Backend, que fornece APIs para...
Esse projeto foi desenvolvido com as seguintes tecnologias:
General:
Os recursos disponíveis da aplicação podem ser encontrados no swagger
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
Para iniciar essa aplicação com docker, siga as instruções de instalação, em seguida utilize o comando:
$ make compose-up
## Para rodar os testes unitários
$ make test
O time utiliza a metologia TDD para implementação de novas funcionalidades, caso não possua conhecimento, é recomendável a leitura do artigo citado.
- Clone o projeto:
- 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
- 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
- Formate os arquivos:
## Para formatar os arquivos
$ make format
- 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'
- Push para a branch:
$ git push origin feature/103574
- Realize um pull request :D
- 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