|
|
@@ -50,6 +50,21 @@ graph TB
|
|
|
|
|
|
## Quick Start
|
|
|
|
|
|
+### Option 1: Dev Container (Recommended)
|
|
|
+
|
|
|
+For the most consistent development experience, use the included dev container:
|
|
|
+
|
|
|
+1. Open in VS Code
|
|
|
+2. When prompted, click "Reopen in Container"
|
|
|
+3. Wait for the container to build and dependencies to install
|
|
|
+4. Start developing!
|
|
|
+
|
|
|
+See `.devcontainer/README.md` for detailed setup instructions.
|
|
|
+
|
|
|
+### Option 2: Local Development
|
|
|
+
|
|
|
+If you prefer local development:
|
|
|
+
|
|
|
```bash
|
|
|
# Install dependencies
|
|
|
pnpm install
|
|
|
@@ -63,15 +78,52 @@ pnpm run service # API server on :3001
|
|
|
pnpm run cli # Interactive CLI
|
|
|
```
|
|
|
|
|
|
-## Documentation
|
|
|
+## Docker Support
|
|
|
+
|
|
|
+The project includes Docker support for containerized deployment and development.
|
|
|
+
|
|
|
+### Running with Docker Compose
|
|
|
+
|
|
|
+```bash
|
|
|
+# Build and run the application
|
|
|
+docker-compose up --build
|
|
|
+
|
|
|
+# Run in detached mode
|
|
|
+docker-compose up -d
|
|
|
+
|
|
|
+# View logs
|
|
|
+docker-compose logs -f
|
|
|
+
|
|
|
+# Stop the application
|
|
|
+docker-compose down
|
|
|
+```
|
|
|
+
|
|
|
+### Docker Image Features
|
|
|
+
|
|
|
+The Docker image includes:
|
|
|
+- **Node.js 20** with pnpm package manager
|
|
|
+- **HandBrake CLI** for video processing
|
|
|
+- **FFmpeg** for media operations
|
|
|
+- **SQLite3** for database management
|
|
|
+- **CLI as Default Shell**: The container starts with the interactive CLI by default
|
|
|
+
|
|
|
+### Using the CLI in Docker
|
|
|
+
|
|
|
+```bash
|
|
|
+# Interactive CLI (default)
|
|
|
+docker-compose run --rm app
|
|
|
+
|
|
|
+# Direct CLI commands
|
|
|
+docker-compose run --rm app files:list --dataset movies
|
|
|
+docker-compose run --rm app task:list
|
|
|
+
|
|
|
+# Override to run development servers
|
|
|
+docker-compose run --rm app pnpm dev
|
|
|
+```
|
|
|
|
|
|
-For detailed information, see:
|
|
|
+### Data Persistence
|
|
|
|
|
|
-- **[Web Interface](apps/web/README.md)** - Next.js dashboard documentation
|
|
|
-- **[API Service](apps/service/README.md)** - NestJS backend and API reference
|
|
|
-- **[CLI Tool](apps/cli/README.md)** - Command-line interface guide
|
|
|
-- **[Database Schema](data/README.md)** - SQLite database structure
|
|
|
-- **[Development Notes](docs/DEVELOPMENT_NOTES.md)** - Setup and development guide
|
|
|
+Database files are persisted in the `./data` directory and mounted into the container for data persistence across container restarts.
|
|
|
|
|
|
## Project Structure
|
|
|
|