Update project configuration and documentation for Reference Board Viewer. Add .direnv support for environment management, enhance README with quick start instructions, and update flake.nix with additional dependencies including pydantic-settings and bcrypt. Introduce quick-start.sh and test-auth.sh scripts for streamlined setup and authentication testing. Remove obsolete planning and task documents to clean up the repository.
This commit is contained in:
27
README.md
27
README.md
@@ -27,13 +27,38 @@ direnv allow # .envrc already configured
|
||||
```
|
||||
|
||||
**Included tools:**
|
||||
- Python 3.12 with all backend dependencies (FastAPI, SQLAlchemy, pytest, etc.)
|
||||
- Python 3.13 with all backend dependencies (FastAPI, SQLAlchemy, pytest, psycopg2, etc.)
|
||||
- Node.js + npm for frontend development
|
||||
- PostgreSQL client tools
|
||||
- MinIO client
|
||||
- Ruff (Python linter/formatter)
|
||||
- All project dependencies from flake.nix
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# 1. Setup (first time only)
|
||||
./scripts/quick-start.sh
|
||||
|
||||
# 2. Start backend (Terminal 1)
|
||||
nix develop
|
||||
cd backend
|
||||
uvicorn app.main:app --reload
|
||||
|
||||
# 3. Start frontend (Terminal 2)
|
||||
cd frontend
|
||||
npm install # first time only
|
||||
npm run dev
|
||||
|
||||
# 4. 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
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user