Template Hackathon - UFRJ Analytica

Template fullstack para hackathons com foco em times de ciência de dados. A ideia é ter o mínimo de infraestrutura já pronto para que o time possa focar na análise e na lógica, não na configuração.

Estrutura do projeto

/
├── backend/       ← API em Python com FastAPI
├── front/         ← Interface web em React + Vite
└── notebooks/     ← Análises exploratórias em Jupyter

Backend (FastAPI)

API REST com Swagger gerado automaticamente.

cd backend
python -m venv venv
source venv/bin/activate   # Windows: venv\Scripts\activate
pip install -r requirements.txt
uvicorn app.main:app --reload

• API: http://localhost:8000
• Swagger: http://localhost:8000/docs

Para adicionar um endpoint novo: crie um serviço em app/services/, crie a rota em app/routes/ e registre no app/main.py. O README dentro da pasta explica o passo a passo.

Front (React + Vite)

Interface que consome a API e exibe os resultados.

cd front
npm install
npm run dev

• App: http://localhost:5173

Para adicionar uma nova tela: crie o componente em src/pages/, adicione a chamada à API em src/services/api.ts e registre no src/App.tsx.

Notebooks (Jupyter)

Pasta para exploração de dados e prototipação de modelos. O que funcionar aqui pode virar um serviço no backend.

cd notebooks
jupyter notebook
# ou: jupyter lab

Há um notebook de exemplo (exploracao.ipynb) já com a conexão à API configurada.

Fluxo sugerido de trabalho

notebooks/          →   backend/app/services/   →   backend/app/routes/   →   front/src/pages/
prototipa a lógica      transforma em função        expõe como endpoint       exibe no browser

Dependências necessárias

Ferramenta	Versão mínima
Python	3.10+
Node.js	18+
Jupyter	qualquer