Fixing how uv is being used in the base image, adding Poe the Poet to everything.
Some checks failed
Tests / Build and Push CICD Base Image (push) Successful in 1m2s
Tests / Build and Push CICD Complete Image (push) Failing after 20m37s
Tests / TSDoc Lint Check (push) Has been skipped
Tests / Trailing Whitespace Check (push) Has been skipped
Tests / End of File Check (push) Has been skipped
Tests / YAML Syntax Check (push) Has been skipped
Tests / TOML Syntax Check (push) Has been skipped
Tests / Mixed Line Ending Check (push) Has been skipped
Tests / TOML Formatting Check (push) Has been skipped
Tests / Ruff Linting (push) Has been skipped
Tests / No Docstring Types Check (push) Has been skipped
Tests / ESLint Check (push) Has been skipped
Tests / Prettier Format Check (push) Has been skipped
Tests / TypeScript Type Check (push) Has been skipped
Tests / Backend Tests (push) Has been skipped
Tests / Frontend Tests (push) Has been skipped
Tests / Ruff Format Check (push) Has been skipped
Tests / Pyright Type Check (push) Has been skipped
Tests / Darglint Docstring Check (push) Has been skipped
Tests / Backend Doctests (push) Has been skipped
Tests / Integration Tests (push) Has been skipped
Tests / End-to-End Tests (push) Has been skipped
Some checks failed
Tests / Build and Push CICD Base Image (push) Successful in 1m2s
Tests / Build and Push CICD Complete Image (push) Failing after 20m37s
Tests / TSDoc Lint Check (push) Has been skipped
Tests / Trailing Whitespace Check (push) Has been skipped
Tests / End of File Check (push) Has been skipped
Tests / YAML Syntax Check (push) Has been skipped
Tests / TOML Syntax Check (push) Has been skipped
Tests / Mixed Line Ending Check (push) Has been skipped
Tests / TOML Formatting Check (push) Has been skipped
Tests / Ruff Linting (push) Has been skipped
Tests / No Docstring Types Check (push) Has been skipped
Tests / ESLint Check (push) Has been skipped
Tests / Prettier Format Check (push) Has been skipped
Tests / TypeScript Type Check (push) Has been skipped
Tests / Backend Tests (push) Has been skipped
Tests / Frontend Tests (push) Has been skipped
Tests / Ruff Format Check (push) Has been skipped
Tests / Pyright Type Check (push) Has been skipped
Tests / Darglint Docstring Check (push) Has been skipped
Tests / Backend Doctests (push) Has been skipped
Tests / Integration Tests (push) Has been skipped
Tests / End-to-End Tests (push) Has been skipped
Signed-off-by: Cliff Hill <xlorep@darkhelm.org>
This commit is contained in:
72
README.md
72
README.md
@@ -32,33 +32,79 @@ This project uses comprehensive linting and formatting:
|
||||
- `vue-tsc` - Vue TypeScript checking
|
||||
- `eslint-plugin-tsdoc` - TSDoc documentation linting
|
||||
|
||||
**Task Runner:**
|
||||
- `poethepoet` - Unified task runner for development workflows
|
||||
|
||||
**General:**
|
||||
- `pre-commit` - Git hooks for automated quality checks
|
||||
- TOML formatting and validation
|
||||
|
||||
### Setting up pre-commit hooks
|
||||
### Unified Development with Poe
|
||||
|
||||
This project uses **Poe the Poet** for streamlined development:
|
||||
|
||||
```bash
|
||||
# Complete setup (installs deps, starts dev environment)
|
||||
poe setup
|
||||
|
||||
# Code quality (format, lint, type-check all code)
|
||||
poe ci-quick
|
||||
|
||||
# Run all tests
|
||||
poe test-all
|
||||
|
||||
# See all available tasks
|
||||
poe --help
|
||||
```
|
||||
|
||||
### Manual Setup (Alternative)
|
||||
|
||||
```bash
|
||||
pip install pre-commit
|
||||
pre-commit install
|
||||
```
|
||||
|
||||
### Running in Development Mode
|
||||
### Quick Start
|
||||
|
||||
1. Clone the repository and navigate to the project directory:
|
||||
1. **Clone the repository**
|
||||
|
||||
2. **Unified Development (Recommended):**
|
||||
```bash
|
||||
cd plex-playlist
|
||||
# Complete setup and start development environment
|
||||
poe setup
|
||||
|
||||
# Or manually:
|
||||
cd backend
|
||||
pip install -e .
|
||||
poe dev-env-start
|
||||
```
|
||||
|
||||
2. Start the development environment:
|
||||
3. **Traditional Setup:**
|
||||
```bash
|
||||
docker compose -f compose.yml -f compose.dev.yml up --build
|
||||
# Backend development
|
||||
cd backend
|
||||
pip install -e .
|
||||
|
||||
# Frontend development
|
||||
cd frontend
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
This will start:
|
||||
- PostgreSQL database on port 5433
|
||||
- FastAPI backend on port 8001 (with hot reload)
|
||||
- Vue.js frontend on port 5173 (with hot reload)
|
||||
4. **Docker Development:**
|
||||
```bash
|
||||
# Using Poe (recommended)
|
||||
poe docker-dev-up
|
||||
|
||||
# Or directly
|
||||
docker compose -f compose.dev.yml up --build
|
||||
```
|
||||
|
||||
5. **Production Build:**
|
||||
```bash
|
||||
poe docker-prod-up
|
||||
# Or: docker compose up --build
|
||||
```
|
||||
|
||||
### Running in Production Mode
|
||||
|
||||
@@ -198,8 +244,14 @@ npm run dev
|
||||
|
||||
### Development & Workflow
|
||||
- **[Development Environment Setup](docs/DEVELOPMENT.md)** - Comprehensive guide for setting up your development environment, git workflow, pre-commit hooks, manual tool usage, and CI/CD pipeline understanding
|
||||
- **[Poe Task Reference](docs/POE_TASK_REFERENCE.md)** - Complete guide to unified development tasks and workflows using Poe the Poet
|
||||
|
||||
### Architecture & CI/CD
|
||||
|
||||
- **[CI/CD Multi-stage Build](docs/CICD_MULTI_STAGE_BUILD.md)** - Docker multi-stage build strategy and optimization
|
||||
|
||||
### Operations & Troubleshooting
|
||||
|
||||
- **[Gitea Actions Troubleshooting](docs/GITEA_ACTIONS_TROUBLESHOOTING.md)** - Solutions for CI/CD pipeline issues, including the critical "jobs waiting forever" problem
|
||||
- **[Secure Docker CI/CD](docs/SECURE_DOCKER_CICD.md)** - Security considerations and setup for Docker-based CI/CD pipelines
|
||||
|
||||
|
||||
Reference in New Issue
Block a user