Base dos Dados

Backend da Base dos Dados, a maior plataforma pública de dados do Brasil.

Tecnologias Utilizadas

Core

• Django como framework web.
• PostgreSQL como banco de dados relacional.
• huey + Redis para agendamento de tarefas.
• Elasticsearch como motor de busca.

API de Dados

• GraphQL (via Graphene-Django) para a API de dados.
• Google Cloud Storage para armazenamento de mídia e acesso aos dados brutos.
• Google BigQuery para acesso aos dados tratados.

Chatbot

• Django REST Framework para a API do chatbot.
• LangChain / LangGraph para desenvolvimento de agentes de IA.
• Google BigQuery para acesso aos dados tratados.
• Vertex AI para acesso a LLMs.

Pagamentos

• Stripe / dj-stripe para o processamento de pagamentos.

Ferramentas de Desenvolvimento

• Poetry para gerenciamento de dependências.
• Docker para conteinerização.
• Pre-commit para gerenciamento de hooks de pre-commit.
• Ruff para formatação.

Configuração do Ambiente de Desenvolvimento

Para começar a desenvolver, configure o ambiente de desenvolvimento seguindo as instruções abaixo:

1. Clone o repositório e abra-o no seu editor de texto.

git clone https://github.com/basedosdados/backend.git

2. Crie um ambiente virtual de desenvolvimento com o Poetry.

poetry install

3. Instale os hooks de pre-commit.

pre-commit install

4. Copie o arquivo .env.example e ajuste as variáveis conforme necessário.

cp .env.example .env

Note

As variáveis de ambiente no arquivo .env.example já estão configuradas para execução com o Docker.

Caso vá utilizar a funcionalidade do chatbot, a conta de serviço deve ser armazenada localmente em ~/.basedosdados/credentials.

Execução do Backend

Utilize o Docker para executar o backend localmente:

docker compose up

Tip

Você também pode utilizar a flag -d --detach e acompanhar os logs utilizando o comando docker logs com a flag -f --follow:

docker compose up -d
docker compose logs api -f

Para parar o serviço:

docker compose down