Skip to content

Commit 00f03a7

Browse files
docs: updated README for project overview
1 parent bba55f4 commit 00f03a7

File tree

1 file changed

+100
-2
lines changed

1 file changed

+100
-2
lines changed

README.md

Lines changed: 100 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,100 @@
1-
# holmes
2-
Project implementation of the legal and investigation project for Gemini 3 Hackathon 2026
1+
# Holmes
2+
3+
**AI-powered legal intelligence platform** — Automates multimodal evidence analysis with transparent AI reasoning.
4+
5+
Built for the [Gemini 3 Global Hackathon 2026](https://ai.google.dev/gemini-api/docs).
6+
7+
## The Problem
8+
9+
Legal professionals spend **60%+ of their time** on manual evidence review across scattered formats — PDFs, video depositions, audio recordings, financial documents. Current AI tools suffer from high hallucination rates and operate as black boxes, making them unusable for legal work that demands transparency and auditability.
10+
11+
## The Solution
12+
13+
Holmes processes **any combination of evidence types** and surfaces connections, contradictions, and gaps — while showing exactly *how* it reached those conclusions through **Agent Flow**, a real-time visualization of AI reasoning.
14+
15+
### Key Capabilities
16+
17+
- **Multimodal Analysis** — PDF, video, audio, images processed together natively via Gemini 3
18+
- **Agent Flow** — Watch AI reasoning unfold in real-time with full transparency
19+
- **Knowledge Graph** — Visual entity-relationship mapping across all evidence
20+
- **Contradiction Detection** — Automatic flagging of conflicting information
21+
- **Hypothesis-Driven Investigation** — AI proposes, human curates, system tracks
22+
- **Span-Level Citations** — Every claim traced to exact source locations
23+
24+
## Tech Stack
25+
26+
| Layer | Technology |
27+
|-------|------------|
28+
| Frontend | Next.js 16, React 19, Tailwind CSS 4, React Flow |
29+
| Backend | FastAPI, Python 3.12, SQLAlchemy 2.0, Alembic |
30+
| Database | PostgreSQL 17 (Cloud SQL) |
31+
| AI | Google ADK, Gemini 3 Pro/Flash |
32+
| Infrastructure | GCP Cloud Run, Cloud Storage, Terraform |
33+
| CI/CD | GitHub Actions with Workload Identity Federation |
34+
35+
## Quick Start
36+
37+
```bash
38+
# Install dependencies
39+
make install
40+
41+
# Start local database
42+
make dev-db && make migrate
43+
44+
# Run services (separate terminals)
45+
make dev-backend # http://localhost:8080
46+
make dev-frontend # http://localhost:3000
47+
```
48+
49+
See [GUIDE.md](./GUIDE.md) for detailed setup instructions.
50+
51+
## Architecture
52+
53+
```
54+
┌─────────────────────────────────────────────────────────────┐
55+
│ Frontend │
56+
│ Next.js 16 · React Flow (Agent Flow) · Knowledge Graph │
57+
└─────────────────────────┬───────────────────────────────────┘
58+
│ SSE (real-time streaming)
59+
┌─────────────────────────▼───────────────────────────────────┐
60+
│ Backend │
61+
│ FastAPI · Google ADK · Multi-Agent Orchestration │
62+
└─────────────────────────┬───────────────────────────────────┘
63+
64+
┌─────────────────┼─────────────────┐
65+
▼ ▼ ▼
66+
┌───────────────┐ ┌───────────────┐ ┌───────────────┐
67+
│ PostgreSQL │ │ Cloud Storage │ │ Gemini 3 │
68+
│ (Sessions, │ │ (Evidence │ │ Pro + Flash │
69+
│ KG, State) │ │ Files) │ │ │
70+
└───────────────┘ └───────────────┘ └───────────────┘
71+
```
72+
73+
### Agent Pipeline
74+
75+
1. **Triage** → Classifies evidence by domain relevance
76+
2. **Domain Agents** → Financial, Legal, Strategy, Evidence analysis (parallel)
77+
3. **Synthesis** → Cross-references findings for contradictions and gaps
78+
4. **Knowledge Graph** → Builds entity-relationship structure
79+
5. **Query Agents** → Chat, Research, Discovery for user interaction
80+
81+
## Project Structure
82+
83+
```
84+
holmes/
85+
├── backend/ # FastAPI + Google ADK agents
86+
├── frontend/ # Next.js 16 + React Flow
87+
├── packages/types/ # Shared TypeScript types (auto-generated)
88+
├── terraform/ # GCP infrastructure
89+
└── .planning/ # Project roadmap and architecture docs
90+
```
91+
92+
## Status
93+
94+
**Phase 1 Complete** — Foundation infrastructure operational with CI/CD, database, storage, and deployment pipeline.
95+
96+
See [.planning/ROADMAP.md](./.planning/ROADMAP.md) for the full 12-phase development plan.
97+
98+
## License
99+
100+
Apache License Version 2.0

0 commit comments

Comments
 (0)