auto-fix linting

2026-02-06 21:53:17 +01:00 · 2026-02-06 21:53:17 +01:00 · 408e8a019b
commit 408e8a019b
parent ccb1a17f44
3 changed files with 106 additions and 105 deletions
--- a/DOCKER.md
+++ b/DOCKER.md
@ -39,24 +39,24 @@ Visit `http://localhost:5173` (hot-reload enabled)

 Docker Compose [profiles](https://docs.docker.com/compose/how-tos/profiles/) control which services start. A service with no profile always runs. A service with a profile only runs when that profile is activated.

-| Command | What starts |
-|---------|-------------|
-| `docker compose up -d` | Monochrome |
-| `docker compose --profile pocketbase up -d` | Monochrome + PocketBase |
-| `docker compose --profile dev up -d` | Monochrome + Dev server |
+| Command                                                   | What starts                          |
+| --------------------------------------------------------- | ------------------------------------ |
+| `docker compose up -d`                                    | Monochrome                           |
+| `docker compose --profile pocketbase up -d`               | Monochrome + PocketBase              |
+| `docker compose --profile dev up -d`                      | Monochrome + Dev server              |
 | `docker compose --profile dev --profile pocketbase up -d` | Monochrome + Dev server + PocketBase |

 In `docker-compose.yml`, it looks like this:

 ```yaml
 services:
-  monochrome:                         # no profile -- always starts
+    monochrome: # no profile -- always starts

-  pocketbase:
-    profiles: ["pocketbase"]          # opt-in
+    pocketbase:
+        profiles: ['pocketbase'] # opt-in

-  monochrome-dev:
-    profiles: ["dev"]                 # opt-in
+    monochrome-dev:
+        profiles: ['dev'] # opt-in
 ```

 ### Override File
@ -72,19 +72,19 @@ The override file does not exist in the upstream repo, don't search it!
 ```yaml
 # docker-compose.override.yml
 services:
-  pocketbase:
-    labels:
-      - traefik.enable=true
-      - traefik.http.routers.pocketbase.rule=Host(`pocketbase.example.com`)
-      - traefik.http.routers.pocketbase.entrypoints=websecure
-      - traefik.http.routers.pocketbase.tls.certresolver=letsencrypt
-      - traefik.http.services.pocketbase.loadbalancer.server.port=8090
-    networks:
-      - proxy-network
+    pocketbase:
+        labels:
+            - traefik.enable=true
+            - traefik.http.routers.pocketbase.rule=Host(`pocketbase.example.com`)
+            - traefik.http.routers.pocketbase.entrypoints=websecure
+            - traefik.http.routers.pocketbase.tls.certresolver=letsencrypt
+            - traefik.http.services.pocketbase.loadbalancer.server.port=8090
+        networks:
+            - proxy-network

 networks:
-  proxy-network:
-    external: true
+    proxy-network:
+        external: true
 ```

 **Example** -- adding a custom service in your fork:
@ -92,13 +92,13 @@ networks:
 ```yaml
 # docker-compose.override.yml
 services:
-  my-custom-api:
-    image: my-api:latest
-    restart: unless-stopped
-    ports:
-      - "4000:4000"
-    networks:
-      - monochrome-network
+    my-custom-api:
+        image: my-api:latest
+        restart: unless-stopped
+        ports:
+            - '4000:4000'
+        networks:
+            - monochrome-network
 ```

 Override files can extend existing services (add labels, env vars, networks) and define entirely new services. See the [Docker docs](https://docs.docker.com/compose/how-tos/multiple-compose-files/merge/) for the full merge behavior.
@ -116,10 +116,10 @@ Portainer can deploy directly from your GitHub fork with auto-updates on push.
 3. Compose path: `docker-compose.yml`
 4. If your fork has a `docker-compose.override.yml`, Portainer loads it automatically
 5. Under **Environment variables**, add:
-   - `COMPOSE_PROFILES=pocketbase` (to enable PocketBase -- omit if not needed)
-   - `PB_ADMIN_EMAIL=your@email.com`
-   - `PB_ADMIN_PASSWORD=your_secure_password`
-   - Any other variables from `.env.example`
+    - `COMPOSE_PROFILES=pocketbase` (to enable PocketBase -- omit if not needed)
+    - `PB_ADMIN_EMAIL=your@email.com`
+    - `PB_ADMIN_PASSWORD=your_secure_password`
+    - Any other variables from `.env.example`
 6. Enable **GitOps updates** to auto-redeploy on push

 > **Tip:** `COMPOSE_PROFILES` is a built-in Docker Compose variable. Setting it to `pocketbase` is equivalent to passing `--profile pocketbase` on the command line.
@ -176,12 +176,12 @@ Node.js Alpine image with source code mounted as a volume for hot-reload.

 ### Files

-| File | Purpose | In upstream repo |
-|------|---------|:---:|
-| `docker-compose.yml` | All services with profiles | Yes |
-| `docker-compose.override.yml` | Fork-specific customizations | No |
-| `.env.example` | Environment variable template | Yes |
-| `.env` | Your local configuration | No |
-| `Dockerfile` | Production build | Yes |
-| `Dockerfile.dev` | Development build | Yes |
-| `.dockerignore` | Build context exclusions | Yes |
+| File                          | Purpose                       | In upstream repo |
+| ----------------------------- | ----------------------------- | :--------------: |
+| `docker-compose.yml`          | All services with profiles    |       Yes        |
+| `docker-compose.override.yml` | Fork-specific customizations  |        No        |
+| `.env.example`                | Environment variable template |       Yes        |
+| `.env`                        | Your local configuration      |        No        |
+| `Dockerfile`                  | Production build              |       Yes        |
+| `Dockerfile.dev`              | Development build             |       Yes        |
+| `.dockerignore`               | Build context exclusions      |       Yes        |
--- a/README.md
+++ b/README.md
@ -120,6 +120,7 @@ Visit `http://localhost:3000`
 For PocketBase, development mode, and advanced setups, see [DOCKER.md](DOCKER.md).

 ### Option 2: Manual Installation
+
 #### Prerequisites

 - [Node.js](https://nodejs.org/) (Version 20+ or 22+ recommended)
--- a/docker-compose.yml
+++ b/docker-compose.yml
@ -1,71 +1,71 @@
 services:
-  # Production frontend -- always runs
-  monochrome:
-    build:
-      context: .
-      dockerfile: Dockerfile
-    container_name: monochrome
-    ports:
-      - "${MONOCHROME_PORT:-3000}:4173"
-    restart: unless-stopped
-    networks:
-      - monochrome-network
-    healthcheck:
-      test: ["CMD", "wget", "--no-verbose", "--tries=1", "--spider", "http://localhost:4173/"]
-      interval: 30s
-      timeout: 3s
-      retries: 3
-      start_period: 5s
+    # Production frontend -- always runs
+    monochrome:
+        build:
+            context: .
+            dockerfile: Dockerfile
+        container_name: monochrome
+        ports:
+            - '${MONOCHROME_PORT:-3000}:4173'
+        restart: unless-stopped
+        networks:
+            - monochrome-network
+        healthcheck:
+            test: ['CMD', 'wget', '--no-verbose', '--tries=1', '--spider', 'http://localhost:4173/']
+            interval: 30s
+            timeout: 3s
+            retries: 3
+            start_period: 5s

-  # PocketBase backend -- only starts with: docker compose --profile pocketbase up -d
-  pocketbase:
-    image: ghcr.io/muchobien/pocketbase:latest
-    container_name: monochrome-pocketbase
-    profiles:
-      - pocketbase
-    restart: unless-stopped
-    environment:
-      PB_ADMIN_EMAIL: ${PB_ADMIN_EMAIL:-admin@example.com}
-      PB_ADMIN_PASSWORD: ${PB_ADMIN_PASSWORD:-changeme}
-      TZ: ${TZ:-UTC}
-    ports:
-      - "${POCKETBASE_PORT:-8090}:8090"
-    volumes:
-      - pb_data:/pb_data
-      - pb_public:/pb_public
-      - pb_hooks:/pb_hooks
-    command: serve --http=0.0.0.0:8090
-    healthcheck:
-      test: ["CMD", "wget", "--no-verbose", "--tries=1", "--spider", "http://localhost:8090/api/health"]
-      interval: 30s
-      timeout: 10s
-      retries: 3
-      start_period: 30s
-    networks:
-      - monochrome-network
+    # PocketBase backend -- only starts with: docker compose --profile pocketbase up -d
+    pocketbase:
+        image: ghcr.io/muchobien/pocketbase:latest
+        container_name: monochrome-pocketbase
+        profiles:
+            - pocketbase
+        restart: unless-stopped
+        environment:
+            PB_ADMIN_EMAIL: ${PB_ADMIN_EMAIL:-admin@example.com}
+            PB_ADMIN_PASSWORD: ${PB_ADMIN_PASSWORD:-changeme}
+            TZ: ${TZ:-UTC}
+        ports:
+            - '${POCKETBASE_PORT:-8090}:8090'
+        volumes:
+            - pb_data:/pb_data
+            - pb_public:/pb_public
+            - pb_hooks:/pb_hooks
+        command: serve --http=0.0.0.0:8090
+        healthcheck:
+            test: ['CMD', 'wget', '--no-verbose', '--tries=1', '--spider', 'http://localhost:8090/api/health']
+            interval: 30s
+            timeout: 10s
+            retries: 3
+            start_period: 30s
+        networks:
+            - monochrome-network

-  # Development server -- only starts with: docker compose --profile dev up -d
-  monochrome-dev:
-    build:
-      context: .
-      dockerfile: Dockerfile.dev
-    container_name: monochrome-dev
-    profiles:
-      - dev
-    ports:
-      - "${MONOCHROME_DEV_PORT:-5173}:5173"
-    volumes:
-      - .:/app
-      - /app/node_modules
-    command: npm run dev -- --host 0.0.0.0
-    networks:
-      - monochrome-network
+    # Development server -- only starts with: docker compose --profile dev up -d
+    monochrome-dev:
+        build:
+            context: .
+            dockerfile: Dockerfile.dev
+        container_name: monochrome-dev
+        profiles:
+            - dev
+        ports:
+            - '${MONOCHROME_DEV_PORT:-5173}:5173'
+        volumes:
+            - .:/app
+            - /app/node_modules
+        command: npm run dev -- --host 0.0.0.0
+        networks:
+            - monochrome-network

 networks:
-  monochrome-network:
-    driver: bridge
+    monochrome-network:
+        driver: bridge

 volumes:
-  pb_data:
-  pb_public:
-  pb_hooks:
+    pb_data:
+    pb_public:
+    pb_hooks: