Skip to content

Commit 217d22b

Browse files
GeNa8880claude
andcommitted
docs: simplify quick start
Co-Authored-By: Claude Opus 4.6 <[email protected]>
1 parent 3d9df51 commit 217d22b

1 file changed

Lines changed: 7 additions & 21 deletions

File tree

README.md

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -50,33 +50,19 @@ graph TB
5050
```bash
5151
git clone https://github.com/ForwardCodeSolutions/rag-engine.git
5252
cd rag-engine
53-
54-
# Install dependencies
55-
curl -LsSf https://astral.sh/uv/install.sh | sh
56-
uv sync
57-
58-
# Configure environment
5953
cp .env.example .env
60-
61-
# Start services (API + Qdrant)
54+
# Edit .env with your API keys
6255
docker compose up -d
63-
# API available at http://localhost:8000/docs
6456
```
6557

66-
## Development
58+
The API is available at `http://localhost:8000/docs`.
6759

68-
```bash
69-
# Run all checks (lint + tests)
70-
make check
60+
### Local Development
7161

72-
# Run tests only
73-
make test
74-
75-
# Run linter only
76-
make lint
77-
78-
# Auto-fix lint issues
79-
make fix
62+
```bash
63+
uv sync # Install dependencies
64+
make check # Lint + tests
65+
make dev # Start with hot reload
8066
```
8167

8268
### Test Suite

0 commit comments

Comments
 (0)