br-acc

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 13 Open GitHub ↗

World Transparency Graph public codebase

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# BRACC Open Graph

[![BRACC Header](https://raw.githubusercontent.com/gliunextage/br-acc/main/docs/brand/bracc-header.jpg)](docs/brand/bracc-header.jpg)

Language: **English** | [Português (Brasil)](README.pt-BR.md)

[![CI](https://github.com/World-Open-Graph/br-acc/actions/workflows/ci.yml/badge.svg)](https://github.com/World-Open-Graph/br-acc/actions/workflows/ci.yml)
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)

BRACC Open Graph is an open-source graph infrastructure for public data intelligence.
Primary website: [bracc.org](https://bracc.org)

BRACC Open Graph is an initiative from [World Open Graph](https://worldopengraph.com).
This repository contains the full code for the public BRACC edition.

## What BRACC Represents

- Public-interest graph infrastructure for transparency work.
- Reproducible ingestion and processing for public records.
- Investigative signals with explicit methodological caution.

Data patterns from public records are signals, not legal proof.

## What Is In This Repository

- Public API (`api/`)
- ETL pipelines and downloaders (`etl/`, `scripts/`)
- Frontend explorer (`frontend/`)
- Infrastructure and schema bootstrap (`infra/`)
- Documentation, legal pack, and release gates (`docs/`, root policies)

## Architecture At A Glance

- Graph DB: Neo4j 5 Community
- Backend: FastAPI (Python 3.12+, async)
- Frontend: Vite + React 19 + TypeScript
- ETL: Python (pandas, httpx)
- Infra: Docker Compose

## Quick Start

```bash
cp .env.example .env
# set at least NEO4J_PASSWORD

make dev

export NEO4J_PASSWORD=your_password
make seed
```

- API: `http://localhost:8000/health`
- Frontend: `http://localhost:3000`
- Neo4j Browser: `http://localhost:7474`

## Repository Map

- `api/`: FastAPI app, routers, Cypher query loading
- `etl/`: pipeline definitions and ETL runtime
- `frontend/`: React application for graph exploration
- `infra/`: Neo4j initialization and compose-related infra
- `scripts/`: operational and validation scripts
- `docs/`: legal, release, and dataset documentation

## Operating Modes / Public-Safe Defaults

Use these defaults for public deployments:

- `PRODUCT_TIER=community`
- `PUBLIC_MODE=true`
- `PUBLIC_ALLOW_PERSON=false`
- `PUBLIC_ALLOW_ENTITY_LOOKUP=false`
- `PUBLIC_ALLOW_INVESTIGATIONS=false`
- `PATTERNS_ENABLED=false`
- `VITE_PUBLIC_MODE=true`
- `VITE_PATTERNS_ENABLED=false`

## Development

```bash
# dependencies
cd api && uv sync --dev
cd ../etl && uv sync --dev
cd ../frontend && npm install

# quality
make check
make neutrality
```

## API Surface

| Method | Route | Description |
|---|---|---|
| GET | `/health` | Health check |
| GET | `/api/v1/public/meta` | Aggregated metrics and source health |
| GET | `/api/v1/public/graph/company/{cnpj_or_id}` | Public company subgraph |
| GET | `/api/v1/public/patterns/company/{cnpj_or_id}` | Returns `503` while pattern engine is disabled |

## Contributing

Contributions are welcome. Start with [CONTRIBUTING.md](CONTRIBUTING.md) for workflow, quality gates, and review expectations.

## Contributors

- [Bruno Cesar](https://github.com/brunoclz) — creator and maintainer
- Codex — AI-assisted engineering contributor

## Legal & Ethics

- [ETHICS.md](ETHICS.md)
- [LGPD.md](LGPD.md)
- [PRIVACY.md](PRIVACY.md)
- [TERMS.md](TERMS.md)
- [DISCLAIMER.md](DISCLAIMER.md)
- [SECURITY.md](SECURITY.md)
- [ABUSE_RESPONSE.md](ABUSE_RESPONSE.md)
- [docs/legal/legal-index.md](docs/legal/legal-index.md)

## License

[GNU Affero General Public License v3.0](LICENSE)

br-acc

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README