Antes de começar, verifique se você atendeu aos seguintes requisitos:
- Acesso a um computador com Python -> (Python 3.11.7)
- Terminal Linux/Mac (ou WSL)
- Docker e docker compose -> (Docker version 26.1.3) - (Docker Compose version v2.27.1)
$ cd pasta/onde/vc/guarda/seus/projetos
$ git https://github.com/evaristofm/api-cliente-jeitto.git
próximo passo: no diretorio raiz do repositório executar:
$ docker compose up -d --build
próximo passo: execute as migrações do projeto usando docker compose + alembic
$ docker compose exec api app alembic upgrade head
Cobertura de testes (ambiente linux)
$ ./tests.sh
Conexão com o banco de dados Postgres
POSTGRES_DB=app || POSTGRES_DB=app_test
POSTGRES_USER=postgres
POSTGRES_PASSWORD=postgres
PORT=5435
Acessando a documentação SWAGGER da API
http://localhost:8000/docs
Comandos CLI que podem ser úteis
o comando abaixo lsita todos os comandos cadastrados no projeto:
docker compose exec api app --help
o seguinte comando lista todos os clientes cadastrados no banco de dados:
docker compose exec api app cliente-list
o próximo comando podemos criar um cliente via linha de comando. Segue um exemplo:
docker compose exec api app cliente-create "John Doe" jhondoe@test.com 81977777777
