Pular para o conteúdo principal

Setup do Ambiente

Configure seu ambiente de desenvolvimento para contribuir com o projeto.

Pré-requisitos​

Antes de começar, instale as seguintes ferramentas:

1. Clone o Repositório​

git clone https://github.com/LiloMarino/SimuladorFinanceiro.git
cd SimuladorFinanceiro

2. Setup do Backend (Python)​

Criar Virtual Environment​

É recomendado usar um ambiente virtual para isolar as dependências do projeto.

Windows:

python -m venv venv
venv\Scripts\activate

Linux/macOS:

python3 -m venv venv
source venv/bin/activate

Instalar Dependências​

pip install -r requirements.txt

Isso instalará todas as dependências necessárias, incluindo:

  • FastAPI
  • Uvicorn
  • SQLAlchemy
  • Socket.IO
  • yfinance
  • E outras

Configurar Variáveis de Ambiente​

O projeto requer PostgreSQL. Configure a connection string via arquivo .env.

# Copiar arquivo de exemplo
cp example.env .env

# Editar .env com suas credenciais do PostgreSQL
nano .env  # ou use seu editor preferido

Exemplo de configuração:

POSTGRES_DATABASE_URL=postgresql+psycopg://postgres:senha@localhost:5432/simulador_financeiro

3. Setup do Frontend (React + TypeScript)​

Instalar Dependências​

cd frontend
pnpm install

Isso instalará todas as dependências do frontend, incluindo:

  • React 19
  • TypeScript
  • Vite
  • TailwindCSS
  • Recharts
  • E outras

4. Executar Localmente​

Para rodar o projeto em modo de desenvolvimento, você precisa de dois terminais (um para backend, outro para frontend).

Terminal 1 — Backend​

Na raiz do projeto:

# Certifique-se de que o virtual environment está ativado
python main.py

O backend rodará em: http://localhost:8000

Swagger Docs

Acesse http://localhost:8000/docs para ver a documentação interativa da API (Swagger UI).

Terminal 2 — Frontend​

Em outro terminal:

cd frontend
pnpm dev

O frontend rodará em: http://localhost:5173

Abra este endereço no navegador para acessar a aplicação.

5. Verificar que Tudo Está Funcionando​

Se ambos os servidores estiverem rodando sem erros:

  • ✅ Backend: Acesse http://localhost:8000/docs (deve mostrar o Swagger)
  • ✅ Frontend: Acesse http://localhost:5173 (deve mostrar a interface)
  • ✅ Conexão: O frontend deve conseguir se comunicar com o backend

Configuração Adicional​

Banco de Dados​

O projeto usa PostgreSQL. Configure o .env com a connection string do PostgreSQL:

  1. Instale o PostgreSQL
  2. Configure o .env com a connection string do PostgreSQL
  3. Reinicie o backend - as tabelas e o banco serão criados automaticamente

Configuração TOML​

Na primeira execução, um arquivo config.toml será criado automaticamente com configurações padrão. Você pode editá-lo para personalizar:

[database]
echo_sql = false  # Mostrar SQL queries no console

[simulation]
start_date = "2000-01-01"
end_date = "2026-01-01"
starting_cash = 10000.00
monthly_contribution = 0.0

[realtime]
use_sse = false  # true para usar SSE ao invés de WebSocket

[host]
nickname = "host"

[server]
port = 8000
provider = "lan"
preferred_vpn = null  # ou "radmin", "hamachi", "tailscale"

Próximos Passos​

Agora que seu ambiente está configurado: