27
README.md
27
README.md
@@ -15,6 +15,33 @@ A full-stack application for managing Plex playlists with a FastAPI backend and
|
||||
|
||||
- Docker and Docker Compose
|
||||
- Git
|
||||
- pre-commit (for development)
|
||||
|
||||
### Code Quality Tools
|
||||
|
||||
This project uses comprehensive linting and formatting:
|
||||
|
||||
**Backend (Python):**
|
||||
- `ruff` - Fast Python linter and formatter
|
||||
- `pyright` - Type checking
|
||||
- `darglint` - Docstring linting (Google style)
|
||||
|
||||
**Frontend (TypeScript/Vue):**
|
||||
- `eslint` - Linting with Vue and TypeScript support
|
||||
- `prettier` - Code formatting
|
||||
- `vue-tsc` - Vue TypeScript checking
|
||||
- `eslint-plugin-tsdoc` - TSDoc documentation linting
|
||||
|
||||
**General:**
|
||||
- `pre-commit` - Git hooks for automated quality checks
|
||||
- TOML formatting and validation
|
||||
|
||||
### Setting up pre-commit hooks
|
||||
|
||||
```bash
|
||||
pip install pre-commit
|
||||
pre-commit install
|
||||
```
|
||||
|
||||
### Running in Development Mode
|
||||
|
||||
|
||||
Reference in New Issue
Block a user