✈️ Mape.ia

Uma aplicação web para planejamento de viagens.

Estrutura do Diretório:

Componentes do projeto:

- frontend
- backend API
- database
- scripts
- Dockerfile

Como Executar:

No windows, abra uma shell Git Bash antes de proceder.

Requirementos:

• python 3.12 atenção especial para o MacOS
• pip
• node
• criar um arquivo .env no seguinte formato:

BRAVE_KEY=#uma chave de api de pesquisa do brave [Brave Search API](https://search.brave.com/help/api)
TEMBO_PSQL_URL=#url completo de uma instância de Postgres+vectorDB da [Tembo.io](https://tembo.io)
OPENAI_KEY=#uma chave de api do [groq](https://groq.com)
HIGH_LIMIT_MODELS='[{"model": "#nome de um modelo LLM", "url": "#url da api de algum provedor de LLMs", "rate_limit": 50000, "key": "#chave de api deste provedor"}]'

Pode-se optar por fornecer o HIGH_LIMIT_MODELS mas não o OPENAI_KEY, para evitar criar também uma chave do groq

Todos exceto o python serão instalados automaticamente no passo seguinte.

Como executar:

No windows, abra uma shell Git Bash antes de proceder Para preparar o ambiente de desenvolvimento no Linux, MacOS, BSD ou outros sistemas com o shell bash, execute:

git clone https://github.com/AndreFGard/dev-software-eq4
cd dev-software-eq4
bash install_tools.sh
python -m playwright install-deps
python -m playwright install

O playwright, uma dependência do crawling do sistema, oferece suporte muito limitado a distribuições que não o Ubuntu. Este issue descreve como resolver esse problema no Archlinux

Executar Frontend:

No Windows:

Usando um shell gitbash

bash frontend_windows.sh

No Linux e MacOS:

cd frontend
npm run dev

Executar Backend:

Após criar o .env,

python -m fastapi dev main.py

Passos tomados no desenvolvimento

• Determinação das tecnologias:
  • Foi escolhido FastAPI como backend e o Svelte.js como framework frontend, com o uso do pydantic e do typescript, respectivamente, para facilitar a validação de tipos e o desenvolvimento do projeto.