RamenGO

Tecnologias Utilizadas

Objetivo do Projeto

O objetivo deste projeto é desenvolver a API RamenGO, uma plataforma que permite aos usuários montar um pedido de ramen, escolhendo entre diversos tipos de caldo e proteínas.

Como Executar

Configuração do Arquivo .env

Para iniciar, é necessário ter Python 3.12 e PostgreSQL 16 instalados no ambiente de desenvolvimento. Após a instalação, preencha o arquivo .env com as seguintes informações para conectar ao banco de dados:

POSTGRES_USER=seu_usuario
POSTGRES_PASSWORD=sua_senha
POSTGRES_DB=nome_do_banco
POSTGRES_SCHEMA=nome_do_esquema
POSTGRES_HOST=localhost
POSTGRES_PORT=5432
PATH_LOGGER=../loggers/log.log
X_API_KEY=sua_api_key

Execução Manual

Criação do Ambiente Virtual
Crie um ambiente virtual para instalar as dependências do projeto:
```
python3.12 -m venv .venv
```

Instalação das Dependências
Ative o ambiente virtual e instale as dependências:

source .venv/bin/activate  # Para Linux/MacOS
.venv\Scripts\activate  # Para Windows
pip install -r requirements.txt

Migração do Banco de Dados
Gere e aplique as migrações do banco de dados:

alembic revision --autogenerate -m "Criação da migração"
alembic upgrade head

Inserção de Dados Iniciais
Insira os dados iniciais na base de dados:
```
export PYTHONPATH=$(pwd)
python src/database/inserts.py
```
Iniciar o FastAPI
Inicie a aplicação FastAPI:
```
uvicorn src.main:app --reload
```
A API estará disponível na porta 8000:
```
http://localhost:8000/docs/
```

Execução com Docker

Build da Imagem Docker
Certifique-se de ter Docker e docker-compose instalados. Construa a imagem:
```
docker-compose build
```
Subir Contêineres
Inicie os contêineres:
```
docker-compose up
```
A aplicação estará disponível na porta 8000 do seu computador:
```
http://localhost:8000/docs/
```