docs: add a guide for running

.env.dev

@@ -1,2 +1,5 @@
+# en-US or cs-CZ.
 LANGUAGE_CODE=en-US
+
+# Required only for mobile native client builds.
 MOBILE_SERVER_URL=

.github/workflows/checkov-check.yaml

@@ -22,7 +22,7 @@ jobs:
         with:
           python-version: "3.13.1"
       - name: Rust toolchain installation
-        uses: dtolnay/rust-toolchain@9bc92bc5598b4f3bec5d910d352094982cb0c3b9 # 1.92.0
+        uses: dtolnay/rust-toolchain@c2b55edffaf41a251c410bb32bed22afefa800f1 # 1.92.0
       - name: code checkout
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
         with:

.github/workflows/rust-check.yaml

@@ -26,7 +26,7 @@ jobs:
           libwebkit2gtk-4.1-dev=2.50.4-0ubuntu0.22.04.1
           libxdo-dev=1:3.20160805.1-4
       - name: Rust toolchain installation
-        uses: dtolnay/rust-toolchain@9bc92bc5598b4f3bec5d910d352094982cb0c3b9 # 1.92.0
+        uses: dtolnay/rust-toolchain@c2b55edffaf41a251c410bb32bed22afefa800f1 # 1.92.0
         with:
           components: clippy, rustfmt
       - name: code checkout

docker-compose-proxy.override.yaml

@@ -8,4 +8,3 @@ services:
 networks:
   web-server-network:
     external: true
- 

docker/prod/app/Dockerfile

@@ -21,7 +21,7 @@ ENV ANDROID_SDK_ROOT=/opt/android-sdk
 SHELL ["/bin/bash", "-o", "pipefail", "-c"]
 
 RUN apt-get update && apt-get install -y --no-install-recommends \
-    openjdk-17-jdk-headless=17.0.17+10-1~deb12u1 \
+    openjdk-17-jdk-headless=17.0.18+8-1~deb12u1 \
  && apt-get clean \
  && rm -rf /var/lib/apt/lists/* \
  && rustup target add aarch64-linux-android \
@@ -46,14 +46,14 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
 
 
 FROM builder_base AS builder_web
- 
+
 RUN dx bundle --locked --release
 
 
 FROM debian:bookworm@sha256:b877a1a3fdf02469440f1768cf69c9771338a875b7add5e80c45b756c92ac20a AS runner_web
 
 RUN apt-get update \
- && apt-get install -y --no-install-recommends libpq5=15.10-0+deb12u1 \
+ && apt-get install -y --no-install-recommends libpq5=15.16-0+deb12u1 \
  && apt-get clean \
  && rm -rf /var/lib/apt/lists/*
 

readme.md

@@ -0,0 +1,59 @@
+# Todo Baggins
+
+A task management app tailored specifically to my personal GTD workflow.
+
+## Running the web server
+
+### Development
+
+1. Copy `.env.dev` to `.env` and, if desired, edit it.
+2. Create a symlink from `docker-compose.yaml` to `docker-compose-dev.yaml`.
+3. Run the Docker compose stack with
+
+   ```sh
+   docker compose up --build -d
+   ```
+
+4. Enter the container shell with
+
+   ```sh
+   docker compose exec -it app sh
+   ```
+
+5. Inside, start the development server with
+
+   ```sh
+   dx serve --locked --addr 0.0.0.0 --port 8000
+   ```
+
+6. Once the build is finished, the web app will be accessible at
+   <http://localhost:8000>.
+
+### Production
+
+1. Copy `.env.dev` to `.env` and, if desired, edit it.
+2. Create a symlink from `docker-compose.yaml` to `docker-compose-prod.yaml`.
+3. Run the Docker compose stack with
+
+   ```sh
+   docker compose up --build -d
+   ```
+
+4. Once the build is finished, the web app will be accessible at the Docker
+   container, on port 80.
+
+## Running the Android client
+
+1. Copy `.env.dev` to `.env` and, if desired, edit it. Set the
+   `MOBILE_SERVER_URL` to the URL of the server which will be available as a
+   backend for the mobile client.
+2. Start the build with
+
+   ```sh
+   ./scripts/export_android_bundle.sh
+   ```
+
+3. Once it is finished, the APK will be present at `bundle/android`.
+4. Run the web server as described in a previous section and make it accessible
+   from the client running the mobile app at the URL specified in the
+   environment variable.