diff --git a/README.md b/README.md index a0bb985..4a5d436 100644 --- a/README.md +++ b/README.md @@ -170,34 +170,36 @@ When running, the FastAPI automatic documentation is available at: ### 1. Create and activate the uv virtual environment ```sh -uv venv plex-playlist -source plex-playlist/bin/activate +cd backend +uv venv .venv +source .venv/bin/activate ``` ### 2. Install dependencies ```sh -uv pip install fastapi uvicorn[standard] -uv pip install ruff +uv sync --all-groups ``` ### 3. Install dev tools ```sh -uv pip install pyright +uv run poe format +uv run poe lint +uv run poe test ``` ### 4. Project structure -- `app/` - FastAPI application code +- `src/backend/` - FastAPI application code - `tests/` - Test suite - `pyrightconfig.json` - Pyright type checking config -- `ruff.toml` - Ruff linter config +- `pyproject.toml` - Ruff, pytest, and task configuration ### 5. Run the development server ```sh -uvicorn app.main:app --reload +uv run uvicorn backend.main:app --reload --app-dir src ``` ---