Início
Documentação para começar a trabalhar com o backend do projeto da iTFLEX.
Diretórios
Em sua máquina, crie um diretório chamado git e dentro dele outro diretório chamado itflex. É nele que você irá realizar os próximos passos.
Clone
Para você ter o código da aplicação em sua máquina, deve ser utilizado o seguinte comando:
- Caso tenha uma chave SSH configurada no Gitlab:
git@git.itflex.com.br:itflex/itflex.git
- Caso não tenha, é possível clonar utilizando usuário e senha com o seguinte comando:
https://git.itflex.com.br/itflex/itflex.git
O código do backend se encontra no diretório server/backend.
Instalação de dependências
Para instalar as dependências, prossiga para o tutorial de acordo com a distribuição Linux que vocês esta utilizando:
Execução
Após clonar o repositório e instalar as dependências, você já pode rodar a aplicação em um ambiente de desenvolvimento.
A aplicação pode ser executada através de deploys para ambientes de staging pelo bot, você pode ler como fazer este processo clicando aqui.
Você também pode criar uma máquina virtual e nela subir a aplicação, você pode ler como fazer este processo clicando aqui.
Testes e Linters
Testes
Os testes podem ser rodados de diferentes maneiras. Segue as principais:
- Executar todos os testes existentes dentro de
itflex/server/backend:
cd ~/git/itflex/server/backend
../helpers/python-test.sh
- Ou executar somente os testes de um módulo específico:
cd ~/git/itflex/server/backend
pytest -vv itflex_auth
- Ou executar um teste em específico de um módulo específico:
cd ~/git/itflex/server/backend
pytest -vv itflex_auth -k test_create_user
Linters
Além dos testes, é importante que seja rodado o linter também. Eles garantem que seu código esteja mais legível e com uma escrita correta.
cd ~/git/itflex/server/backend
../helpers/python-lint.sh