phase 5
This commit is contained in:
29
README.md
29
README.md
@@ -14,6 +14,13 @@ This project follows a formal constitution that establishes binding principles f
|
||||
|
||||
📖 **Full constitution:** [`.specify/memory/constitution.md`](.specify/memory/constitution.md)
|
||||
|
||||
## Documentation
|
||||
|
||||
- 📚 **[Getting Started Guide](docs/getting-started.md)** - Complete setup walkthrough
|
||||
- 🔧 **[Nix Services](docs/development/nix-services.md)** - Service management
|
||||
- 📋 **[Specification](specs/001-reference-board-viewer/spec.md)** - Requirements & design
|
||||
- 📊 **[Milestones](docs/milestones/)** - Phase completion reports
|
||||
|
||||
## Development Environment
|
||||
|
||||
This project uses Nix flakes for reproducible development environments:
|
||||
@@ -37,27 +44,35 @@ direnv allow # .envrc already configured
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# 1. Setup (first time only)
|
||||
./scripts/quick-start.sh
|
||||
|
||||
# 2. Start backend (Terminal 1)
|
||||
# 1. Enter Nix development environment
|
||||
nix develop
|
||||
|
||||
# 2. Start development services (PostgreSQL + MinIO)
|
||||
./scripts/dev-services.sh start
|
||||
|
||||
# 3. Setup backend (first time only)
|
||||
cd backend
|
||||
alembic upgrade head
|
||||
cd ..
|
||||
|
||||
# 4. Start backend (Terminal 1)
|
||||
cd backend
|
||||
uvicorn app.main:app --reload
|
||||
|
||||
# 3. Start frontend (Terminal 2)
|
||||
# 5. Start frontend (Terminal 2)
|
||||
cd frontend
|
||||
npm install # first time only
|
||||
npm run dev
|
||||
|
||||
# 4. Test authentication (Terminal 3)
|
||||
# 6. Test authentication (Terminal 3)
|
||||
./scripts/test-auth.sh
|
||||
```
|
||||
|
||||
**Access:**
|
||||
- Frontend: http://localhost:5173
|
||||
- Backend API Docs: http://localhost:8000/docs
|
||||
- Backend Health: http://localhost:8000/health
|
||||
- MinIO Console: http://localhost:9001
|
||||
- PostgreSQL: `psql -h localhost -U webref webref`
|
||||
|
||||
## Code Quality & Linting
|
||||
|
||||
|
||||
Reference in New Issue
Block a user