Align README backend manual setup with current layout
Some checks failed
Tests / Build and Push CICD Base Image (pull_request) Successful in 1h0m44s
Tests / Build and Push CICD Complete Image (pull_request) Failing after 5m56s
Tests / Trailing Whitespace Check (pull_request) Has been skipped
Tests / End of File Check (pull_request) Has been skipped
Tests / YAML Syntax Check (pull_request) Has been skipped
Tests / TOML Syntax Check (pull_request) Has been skipped
Tests / Mixed Line Ending Check (pull_request) Has been skipped
Tests / TOML Formatting Check (pull_request) Has been skipped
Tests / Ruff Linting (pull_request) Has been skipped
Tests / Ruff Format Check (pull_request) Has been skipped
Tests / Pyright Type Check (pull_request) Has been skipped
Tests / Darglint Docstring Check (pull_request) Has been skipped
Tests / No Docstring Types Check (pull_request) Has been skipped
Tests / ESLint Check (pull_request) Has been skipped
Tests / Prettier Format Check (pull_request) Has been skipped
Tests / TypeScript Type Check (pull_request) Has been skipped
Tests / TSDoc Lint Check (pull_request) Has been skipped
Tests / Backend Tests (pull_request) Has been skipped
Tests / Frontend Tests (pull_request) Has been skipped
Tests / Backend Doctests (pull_request) Has been skipped
Tests / Integration Tests (pull_request) Has been skipped
Tests / End-to-End Tests (pull_request) Has been skipped
Some checks failed
Tests / Build and Push CICD Base Image (pull_request) Successful in 1h0m44s
Tests / Build and Push CICD Complete Image (pull_request) Failing after 5m56s
Tests / Trailing Whitespace Check (pull_request) Has been skipped
Tests / End of File Check (pull_request) Has been skipped
Tests / YAML Syntax Check (pull_request) Has been skipped
Tests / TOML Syntax Check (pull_request) Has been skipped
Tests / Mixed Line Ending Check (pull_request) Has been skipped
Tests / TOML Formatting Check (pull_request) Has been skipped
Tests / Ruff Linting (pull_request) Has been skipped
Tests / Ruff Format Check (pull_request) Has been skipped
Tests / Pyright Type Check (pull_request) Has been skipped
Tests / Darglint Docstring Check (pull_request) Has been skipped
Tests / No Docstring Types Check (pull_request) Has been skipped
Tests / ESLint Check (pull_request) Has been skipped
Tests / Prettier Format Check (pull_request) Has been skipped
Tests / TypeScript Type Check (pull_request) Has been skipped
Tests / TSDoc Lint Check (pull_request) Has been skipped
Tests / Backend Tests (pull_request) Has been skipped
Tests / Frontend Tests (pull_request) Has been skipped
Tests / Backend Doctests (pull_request) Has been skipped
Tests / Integration Tests (pull_request) Has been skipped
Tests / End-to-End Tests (pull_request) Has been skipped
This commit is contained in:
18
README.md
18
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
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user