https://github.com/the-akira/fastapi
Aplicação Experimental construída com FastAPI e SQLModel
https://github.com/the-akira/fastapi
Last synced: about 2 months ago
JSON representation
Aplicação Experimental construída com FastAPI e SQLModel
- Host: GitHub
- URL: https://github.com/the-akira/fastapi
- Owner: the-akira
- Created: 2024-08-19T02:24:25.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-08-19T06:09:53.000Z (8 months ago)
- Last Synced: 2025-01-18T18:45:31.579Z (3 months ago)
- Language: Python
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Experimento FastAPI
Aplicação construída com FastAPI e SQLModel, utilizando Docker para facilitar o setup do ambiente. Ela permite fazer scraping de conteúdo da web e armazenar os dados em um banco de dados PostgreSQL. Também possibilita o envio de e-mails de forma assíncrona em segundo plano.
## Requisitos
- Docker
- Docker Compose
## Instalação
### Clonar o Repositório
```
git clone https://github.com/the-akira/FastAPI.git
cd FastAPI
```
### Configurar Variáveis de Ambiente
Crie um arquivo `.env` na raiz do projeto com o seguinte conteúdo:
```
POSTGRES_USER=myuser
POSTGRES_PASSWORD=mypassword
POSTGRES_DB=mydatabase
DB_URL=postgresql+asyncpg://${POSTGRES_USER}:${POSTGRES_PASSWORD}@db:5432/${POSTGRES_DB}
EMAIL=enderecoemail
EMAIL_PASSWORD=senhaemail
```
Substitua as informações com as suas credenciais.
### Iniciando a Aplicação
```
docker-compose up --build
```
Isso vai construir os containers e iniciar a aplicação.
### Executando Migrações com Alembic
```
docker-compose exec web alembic revision --autogenerate -m "Initial migration"
docker-compose exec web alembic upgrade head
```
### Acessando os Containers
```
docker ps
docker exec -it 7d11ccb5759a /bin/bash
docker exec -it 18f535251ccb -U myuser -d mydatabase
```
### Executando os Testes
```
python -m unittest tests.test_app
```
### Uso
A aplicação estará disponível em `http://127.0.0.1:8000`.
### Documentação
Você pode acessar a documentação automática da API em `http://127.0.0.1:8000/docs`.