https://github.com/eduardoklosowski/exercicio-curso-fastapi-do-zero
Exercícios do curso FastAPI do Zero
https://github.com/eduardoklosowski/exercicio-curso-fastapi-do-zero
exercise fastapi
Last synced: 6 months ago
JSON representation
Exercícios do curso FastAPI do Zero
- Host: GitHub
- URL: https://github.com/eduardoklosowski/exercicio-curso-fastapi-do-zero
- Owner: eduardoklosowski
- Archived: true
- Created: 2024-07-24T04:35:55.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-08-07T04:01:11.000Z (10 months ago)
- Last Synced: 2024-12-17T12:13:38.155Z (6 months ago)
- Topics: exercise, fastapi
- Language: Python
- Homepage:
- Size: 138 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Meu FastAPI do Zero
Minha versão do código do curso [FastAPI do Zero](https://fastapidozero.dunossauro.com/).
As principais diferenças são:
- Utilização do [Dev Containers](https://containers.dev/) para a criação automática do ambiente de desenvolvimento integrado ao [Visual Studio Code](https://code.visualstudio.com/).
- Utilização do [GNU Make](https://www.gnu.org/software/make/) no lugar do [taskipy](https://pypi.org/project/taskipy/), o que possibilita a execução em paralelo das ferramentas.
## Como Executar?
Esse projeto requer as seguintes ferramentas instaladas:
- [Docker Engine](https://docs.docker.com/engine/)
- [Docker Compose](https://docs.docker.com/compose/)
- [Visual Studio Code](https://code.visualstudio.com/Download)
- Plugin [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
Após isso, ao abrir o projeto no VS Code, será sugerido abrir o projeto dentro de um contêiner, ao aceitar, todo o ambiente necessário para desenvolver a aplicação será criado.
### Executar Testes no Commit (Opcional)
É possível configurar o repositório para executar os lints e testes antes de cada commit, dessa forma o git só fará o commit caso essas ferramentas não identifiquem problemas (nenhuma regra de lint sendo quebrada e testes passando), caso contrário o git não realizará o commit, dando a possibilidade de corrigir o erro antes de tentar fazer o commit novamente (ou o parâmetro `--no-verify` seja usado no `git commit`).
Para ativar essa verificação basta executar os comandos a baixo na raiz do projeto:
```sh
cat > .git/hooks/pre-commit << EOF
#!/bin/sh
make lint test
EOF
chmod +x .git/hooks/pre-commit
```
Caso queira agilizar o processo, é possível executar as ferramentas de verificação em paralelo, porém a saída delas poderá ficar embaralhada. Para configurar a execução do número de ferramentas igual ao número de núcleos de CPU disponível, basta usar o parâmetro `-j` do `make`, como no exemplo a seguir:
```sh
cat > .git/hooks/pre-commit << EOF
#!/bin/sh
make -j lint test
EOF
chmod +x .git/hooks/pre-commit
```
### pgAdmin4
Este esse projeto possui o [pgAdmin4](https://www.pgadmin.org/) para a adiministração do banco de dados [PostgreSQL](https://www.postgresql.org/). Use as informações a baixo para acessá-lo:
```txt
URL: http://localhost:5050/
Usuário: [email protected]
Senha: postgres
Senha do banco: postgres
```