mirror of
https://github.com/Frooodle/Stirling-PDF.git
synced 2026-05-10 23:10:08 +02:00
702f4e5c2c
## Add Taskfile for unified dev workflow ### Summary - Introduces [Taskfile](https://taskfile.dev/) as the single CLI entry point for all development workflows across backend, frontend, engine, Docker, and desktop - ~80 tasks organized into 6 namespaces: `backend:`, `frontend:`, `engine:`, `docker:`, `desktop:`, plus root-level composites - All CI workflows migrated to use Task - Deletes `engine/Makefile` and `scripts/build-tauri-jlink.{sh,bat}` — replaced by Task equivalents - Removes redundant npm scripts (`dev`, `build`, `prep`, `lint`, `test`, `typecheck:all`) from `package.json` - Smart dependency caching: `sources`/`status`/`generates` fingerprinting, CI-aware `npm ci` vs `npm install`, `run: once` for parallel dep deduplication ### What this does NOT do - Does not replace Gradle, npm, or Docker — Taskfile is a thin orchestration wrapper - Does not change application code or behavior ### Install ``` npm install -g @go-task/cli # or: brew install go-task, winget install Task.Task ``` ### Quick start ``` task --list # discover all tasks task install # install all deps task dev # start backend + frontend task dev:all # also start AI engine task test # run all tests task check # quick quality gate (local dev) task check:all # full CI quality gate ``` ### Test plan - [ ] Install `task` CLI and run `task --list` — verify all tasks display - [ ] Run `task install` — verify frontend + engine deps install - [ ] Run `task dev` — verify backend + frontend start, Ctrl+C exits cleanly - [ ] Run `task frontend:check` — verify typecheck + lint + test pass - [ ] Run `task desktop:dev` — verify jlink builds are cached on second run - [ ] Verify CI passes on all workflows --------- Co-authored-by: James Brunton <jbrunton96@gmail.com>
81 lines
2.9 KiB
Markdown
81 lines
2.9 KiB
Markdown
# Docker Setup for Stirling-PDF
|
|
|
|
This directory contains the organized Docker configurations for the split frontend/backend architecture.
|
|
|
|
## Using Taskfile (Recommended)
|
|
|
|
All Docker commands can be run from the project root using [Task](https://taskfile.dev/):
|
|
|
|
```bash
|
|
task docker:build # Build standard image
|
|
task docker:build:fat # Build fat image (all features)
|
|
task docker:build:ultra-lite # Build ultra-lite image
|
|
task docker:build:frontend # Build frontend-only image
|
|
task docker:build:engine # Build engine image
|
|
task docker:up # Start standard compose stack
|
|
task docker:up:fat # Start fat compose stack
|
|
task docker:up:ultra-lite # Start ultra-lite compose stack
|
|
task docker:down # Stop all running stacks
|
|
task docker:logs # Tail compose logs
|
|
```
|
|
|
|
## Directory Structure
|
|
|
|
```
|
|
docker/
|
|
├── backend/ # Backend Docker files
|
|
│ ├── Dockerfile # Standard backend
|
|
│ ├── Dockerfile.ultra-lite # Minimal backend
|
|
│ └── Dockerfile.fat # Full-featured backend
|
|
├── frontend/ # Frontend Docker files
|
|
│ ├── Dockerfile # React/Vite frontend with nginx
|
|
│ ├── nginx.conf # Nginx configuration
|
|
│ └── entrypoint.sh # Dynamic backend URL setup
|
|
└── compose/ # Docker Compose files
|
|
├── docker-compose.yml # Standard setup
|
|
├── docker-compose.ultra-lite.yml # Ultra-lite setup
|
|
└── docker-compose.fat.yml # Full-featured setup
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Separate Containers (Recommended)
|
|
|
|
From the project root directory:
|
|
|
|
```bash
|
|
# Standard version
|
|
docker-compose -f docker/compose/docker-compose.yml up --build
|
|
|
|
# Ultra-lite version
|
|
docker-compose -f docker/compose/docker-compose.ultra-lite.yml up --build
|
|
|
|
# Fat version
|
|
docker-compose -f docker/compose/docker-compose.fat.yml up --build
|
|
```
|
|
|
|
|
|
## Access Points
|
|
|
|
- **Frontend**: http://localhost:3000
|
|
- **Backend API (debugging)**: http://localhost:8080 (TODO: Remove in production)
|
|
- **Backend API (via frontend)**: http://localhost:3000/api/*
|
|
|
|
## Configuration
|
|
|
|
- **Backend URL**: Set `VITE_API_BASE_URL` environment variable for custom backend locations
|
|
- **Custom Ports**: Modify port mappings in docker-compose files
|
|
- **Memory Limits**: Adjust memory limits per variant (2G ultra-lite, 4G standard, 6G fat)
|
|
|
|
### [Google Drive Integration](https://developers.google.com/workspace/drive/picker/guides/overview)
|
|
|
|
- **VITE_GOOGLE_DRIVE_CLIENT_ID**: [OAuth 2.0 Client ID](https://console.cloud.google.com/auth/clients/create)
|
|
- **VITE_GOOGLE_DRIVE_API_KEY**: [Create New API](https://console.cloud.google.com/apis)
|
|
- **VITE_GOOGLE_DRIVE_APP_ID**: This is your [project number](https://console.cloud.google.com/iam-admin/settings) in the GoogleCloud Settings
|
|
|
|
## Development vs Production
|
|
|
|
- **Development**: Keep backend port 8080 exposed for debugging
|
|
- **Production**: Remove backend port exposure, use only frontend proxy
|
|
|