Requisitos | Tecnologias | Como Usar
Para executar este projeto, você precisará das seguintes ferramentas:
| Ferramenta | Versão | Descrição |
|---|---|---|
| Poetry | 1.8.2 | Gerenciador de dependências para projetos Python |
| Python | 3.11 | Linguagem de programação |
| Jinja2 | 3.1.4 | templating engine |
| Alembic | 1.12.0 | migração de banco de dados para uso com o SQLAlchemy |
| SQLAlchemy | 2.0.22 | kit de ferramentas Python SQL (ORM) |
| pydantic | 2.4.2 | biblioteca de validação de dados |
| Git | - | Sistema de controle de versões |
| SQLite | - | Sistema de gerenciamento de banco de dados |
Este projeto utiliza as seguintes tecnologias:
- Gerenciador de dependências: Poetry
- Linguagem e ambiente de desenvolvimento: Python
- Templete engine para o front-end Jinja2
- ORM (Object-Relational Mapper): SQLAlchemy
- Banco de dados: SQLite
Siga as instruções abaixo para configurar e executar o projeto:
# Clone este repositório
git clone https://github.com/jvras58/fastapi-api.git
# Navegue até o diretório do projeto
cd fastapi-api
# Crie o arquivo .env com os valores adequados ao ambiente
cp .env-sample .env
# Cria a pasta .secrets
$ mkdir .secrets
# Cria o arquivo TESTE_SECRET dentro da pasta .secrets e adiciona o conteúdo TESTE_SECRET
$ echo "TESTE_SECRET" > .secrets/TESTE_SECRET
# Entre no ambiente virtual gerenciado pelo Poetry
poetry shell
# Instale as dependências do projeto
poetry install
# Execute as migrações do banco de dados
alembic upgrade head
# Execute os testes para verificar se a API está funcionando corretamente
task test
# Inicie a API
task run- A API estará disponível localmente em: http://localhost:8000/
- O frontend pode ser acessado em: http://localhost:8000/template/index
Contribuições são bem-vindas! Se você encontrar algum problema ou tiver alguma sugestão, sinta-se à vontade para abrir uma issue ou enviar um pull request.
Este projeto está licenciado sob a MIT License.
Desenvolvido com ❤️ por jvras