Initial commit: Research Bridge API with Podman support
This commit is contained in:
57
README.md
Normal file
57
README.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# Research Bridge
|
||||
|
||||
SearXNG + Kimi for Coding research pipeline. Self-hosted alternative to Perplexity with **$0 running costs**.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# 1. Clone and setup
|
||||
cd ~/data/workspace/projects/research-bridge
|
||||
python -m venv .venv
|
||||
source .venv/bin/activate
|
||||
pip install -e ".[dev]"
|
||||
|
||||
# 2. Start SearXNG
|
||||
docker-compose -f config/searxng-docker-compose.yml up -d
|
||||
|
||||
# 3. Configure
|
||||
export RESEARCH_BRIDGE_KIMI_API_KEY="sk-kimi-..."
|
||||
|
||||
# 4. Run
|
||||
python -m src.main
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:8000/research \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"query": "latest rust web frameworks", "depth": "shallow"}'
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Technical Design Document](docs/TDD.md) - Complete specification
|
||||
- [AI Council Review](docs/AI_COUNCIL_REVIEW.md) - Architecture review
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
research-bridge/
|
||||
├── src/
|
||||
│ ├── api/ # FastAPI routes
|
||||
│ ├── search/ # SearXNG client
|
||||
│ ├── llm/ # Kimi for Coding synthesizer
|
||||
│ ├── models/ # Pydantic models
|
||||
│ └── middleware/ # Rate limiting, auth
|
||||
├── tests/
|
||||
│ ├── unit/ # Mocked, isolated
|
||||
│ ├── integration/ # With real SearXNG
|
||||
│ └── e2e/ # Full flow
|
||||
├── config/ # Docker, settings
|
||||
└── docs/ # Documentation
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
Reference in New Issue
Block a user