RELab v0.2.0

.cspell.yaml

@@ -0,0 +1,84 @@
+version: "0.2"
+dictionaries:
+  - coding-terms
+  - cpp-compound-words
+  - data-science
+  - docker
+  - en-gb
+  - en-us
+  - filetypes
+  - fullstack
+  - npm
+  - python
+  - python-common
+  - software-tools
+enabled: true
+enabledFileTypes:
+  "*": true
+ignorePaths:
+  - .devcontainer
+  - .dockerignore
+  - .git
+  - .gitignore
+  - .vscode
+  - package-lock.json
+  - uv.lock
+  - "frontend-app/src/assets/data/**"
+language: en_us,nl
+words:
+  - categorymateriallink
+  - categoryproducttypelink
+  - circularityproperties
+  - crowdsource
+  - dismissable
+  - Donati
+  - ERD
+  - fileparenttype
+  - imageparenttype
+  - Lierde
+  - materialproductlink
+  - newslettersubscriber
+  - orcid
+  - organizationrole
+  - oauthaccount
+  - physicalproperties
+  - pressable
+  - primaryjoin
+  - producttype
+  - relab
+  - remanufacturability
+  - remanufacturable
+  - repairability
+  - selectinload
+  - shellcheck
+  - subcomponent
+  - subcomponents
+  - subrepo
+  - subrepos
+  - supercategory
+  - taxonomydomain
+  - tsquery
+  - tsvector
+  - trixie
+  - UNEP
+  - viewability
+  - zenodo
+
+  # Temp
+  - ASGI
+  - Caddyfile
+  - cloudflared
+  - Fernet
+  - fontawesome
+  - justfile
+  - mdformat
+  - mjml
+  - rclone
+  - Zensical
+
+ignoreWords:
+  - ellipsize
+  - htmlcov
+  - piexif
+  - worklets
+  - xdist

.devcontainer/backend/devcontainer.json

@@ -7,14 +7,13 @@
   // The local workspace is mounted in /opt/relab for git integration
   "mounts": ["source=${localWorkspaceFolder},target=/opt/relab,type=bind,consistency=cached"],
   "overrideCommand": true,
-  "postCreateCommand": "",
-  "postAttachCommand": "echo '🚀 Backend dev container ready!\\n💡 To start the FastAPI dev server, run: fastapi dev\\n🔄 If that fails, try: uv run fastapi dev\\n🌐 The server will be available at http://localhost:8011 (forwarded port)'",
+  "postAttachCommand": "echo '🚀 Backend dev container ready!\\n📦 If .venv is missing, run: uv sync\\n💡 To start the FastAPI dev server, run: fastapi dev\\n🔄 If that fails, try: uv run fastapi dev\\n🌐 The server will be available at http://localhost:8011 (forwarded port)'",
   "features": {
     "ghcr.io/devcontainers/features/git:1": {}
   },
   "customizations": {
     "vscode": {
-      "extensions": ["charliermarsh.ruff", "ms-python.python", "wholroyd.jinja"],
+      "extensions": ["astral-sh.ty", "charliermarsh.ruff", "ms-python.python", "wholroyd.jinja"],
       "settings": {
         "[python][notebook]": {
           "editor.codeActionsOnSave": {
@@ -27,8 +26,6 @@
         "python-envs.terminal.showActivateButton": true,
         "python.analysis.autoFormatStrings": true,
         "python.analysis.typeCheckingMode": "standard",
-        "python.linting.enabled": true,
-        "python.linting.ruffEnabled": true,
         "python.terminal.activateEnvInCurrentTerminal": true,
         "python.terminal.activateEnvironment": true,
         "python.testing.pytestEnabled": true

.devcontainer/devcontainer.json

@@ -1,25 +1,27 @@
 {
   "name": "relab-fullstack",
   "dockerComposeFile": ["../compose.yml", "../compose.override.yml"],
-  "service": "frontend-web",
+  "service": "frontend-app",
   "workspaceFolder": "/opt/relab",
   "mounts": ["source=${localWorkspaceFolder},target=/opt/relab,type=bind,consistency=cached"],
   "features": {
     "ghcr.io/devcontainers/features/git:1": {},
     "ghcr.io/devcontainers-extra/features/expo-cli:1": {},
     "ghcr.io/jsburckhardt/devcontainer-features/uv:1": {}
   },
-  "postAttachCommand": "echo '🚀 Fullstack dev container ready!\\n💡 Frontend: http://localhost:8010\\n💡 Backend: http://localhost:8011\\n💡 Docs: http://localhost:8012 (all forwarded ports)'",
+  "postAttachCommand": "echo '🚀 Fullstack dev container ready!\\n📦 If node_modules/.venv are missing, run npm ci and uv sync in the relevant subrepo\\n💡 Web frontend: http://localhost:8010\\n💡 Backend: http://localhost:8011\\n💡 Docs: http://localhost:8012\\n💡 App frontend: http://localhost:8013'",
   "customizations": {
     "vscode": {
       "extensions": [
         // Frontend
+        "astro-build.astro-vscode",
         "msjsdiag.vscode-react-native",
         "christian-kohler.npm-intellisense",
         "esbenp.prettier-vscode",
         "dbaeumer.vscode-eslint",
         "expo.vscode-expo-tools",
         // Backend
+        "astral-sh.ty",
         "charliermarsh.ruff",
         "ms-python.python",
         "wholroyd.jinja",
@@ -51,8 +53,6 @@
           "editor.defaultFormatter": "charliermarsh.ruff"
         },
         "python.analysis.typeCheckingMode": "standard",
-        "python.linting.enabled": true,
-        "python.linting.ruffEnabled": true,
         "python.terminal.activateEnvInCurrentTerminal": true,
         "python.terminal.activateEnvironment": true,
         "python.testing.pytestEnabled": true,

.devcontainer/docs/devcontainer.json

@@ -10,7 +10,7 @@
       [Devcontainer: /opt/relab/docs]  ⇄  [Local ./docs]  ⇄  [Devcontainer: /docs]
 
     - Edit in git-integrated /opt/relab/docs (devcontainer) → updates local ./docs
-    - MkDocs in the devcontainer live reloads /docs (synced from local ./docs)
+    - Zensical in the devcontainer live reloads /docs (synced from local ./docs)
   */
   "mounts": ["source=${localWorkspaceFolder},target=/opt/relab,type=bind,consistency=cached"],
   "features": {
@@ -25,20 +25,20 @@
         "DavidAnson.vscode-markdownlint",
         "shd101wyy.markdown-preview-enhanced",
         "yzhang.markdown-all-in-one"
-      ]
-    },
-    "settings": {
-      "[markdown]": {
-        "editor.defaultFormatter": "DavidAnson.vscode-markdownlint"
-      },
-      "editor.formatOnSave": true,
-      "github.copilot.enable": {
-        "markdown": true
-      },
-      "markdown.extension.completion.enabled": true,
-      "markdown.extension.orderedList.marker": "one",
-      "markdown.extension.tableFormatter.normalizeIndentation": true,
-      "markdown.extension.theming.decoration.renderTrailingSpace": true
+      ],
+      "settings": {
+        "[markdown]": {
+          "editor.defaultFormatter": "DavidAnson.vscode-markdownlint"
+        },
+        "editor.formatOnSave": true,
+        "github.copilot.enable": {
+          "markdown": true
+        },
+        "markdown.extension.completion.enabled": true,
+        "markdown.extension.orderedList.marker": "one",
+        "markdown.extension.tableFormatter.normalizeIndentation": true,
+        "markdown.extension.theming.decoration.renderTrailingSpace": true
+      }
     }
   }
 }

.devcontainer/frontend/devcontainer.json → .devcontainer/frontend-app/devcontainer.json

@@ -1,13 +1,13 @@
 {
-  "name": "relab-frontend-web",
+  "name": "relab-frontend-app",
   "dockerComposeFile": ["../../compose.yml", "../../compose.override.yml"],
-  "service": "frontend-web",
-  "runServices": ["frontend-web"],
-  "workspaceFolder": "/opt/relab/frontend-web",
+  "service": "frontend-app",
+  "runServices": ["frontend-app"],
+  "workspaceFolder": "/opt/relab/frontend-app",
   // The local workspace is mounted in /opt/relab for git integration
-  "mounts": ["source=${localWorkspaceFolder},target=/opt/relab,type=bind,consistency=cached"],
+  "mounts": ["source=${localWorkspaceFolder},target=/opt/relab,type=bind"],
   "overrideCommand": true,
-  "postAttachCommand": "echo '🚀 Frontend dev container ready!\\n💡 To start the Expo dev server, run: npx expo start --web\\n🌐 The server will be available at http://localhost:8010 (forwarded port)'",
+  "postAttachCommand": "echo '🚀 App frontend dev container ready!\\n📦 If node_modules is missing, run: npm ci\\n💡 To start the Expo dev server, run: npx expo start --web\\n🌐 The server will be available at http://localhost:8013 (forwarded port)'",
   "features": {
     "ghcr.io/devcontainers/features/git:1": {},
     "ghcr.io/devcontainers-extra/features/expo-cli:1": {}

.devcontainer/frontend-web/devcontainer.json

@@ -0,0 +1,30 @@
+{
+  "name": "relab-frontend-web",
+  "dockerComposeFile": ["../../compose.yml", "../../compose.override.yml"],
+  "service": "frontend-web",
+  "runServices": ["frontend-web"],
+  "workspaceFolder": "/opt/relab/frontend-web",
+  // The local workspace is mounted in /opt/relab for git integration
+  "mounts": ["source=${localWorkspaceFolder},target=/opt/relab,type=bind,consistency=cached"],
+  "overrideCommand": true,
+  "postAttachCommand": "echo '🚀 Web frontend dev container ready!\\n📦 If node_modules is missing, run: npm ci\\n💡 To start the Astro dev server, run: npx astro dev\\n🌐 The server will be available at http://localhost:8010 (forwarded port)'",
+  "features": {
+    "ghcr.io/devcontainers/features/git:1": {}
+  },
+  "customizations": {
+    "vscode": {
+      "extensions": ["astro-build.astro-vscode", "biomejs.biome", "christian-kohler.npm-intellisense"],
+      "settings": {
+        "editor.formatOnSave": true,
+        "biome.requireConfiguration": true,
+        "[astro][javascript][typescript][javascriptreact][typescriptreact][json][jsonc]": {
+          "editor.defaultFormatter": "biomejs.biome",
+          "editor.codeActionsOnSave": {
+            "source.fixAll.biome": "always",
+            "source.organizeImports.biome": "always"
+          }
+        }
+      }
+    }
+  }
+}

.env.example

@@ -1,14 +1,22 @@
 # Example of root .env file
+# Copy this file to .env and fill in the values marked with 🔀.
 
 # Enable docker compose bake
 COMPOSE_BAKE=true
 
-# Cloudflare Tunnel Token
-TUNNEL_TOKEN=your_token
+# Cloudflare Tunnel Tokens (used by compose.prod.yml and compose.staging.yml)
+TUNNEL_TOKEN_PROD=your_token    # 🔀
+TUNNEL_TOKEN_STAGING=your_token # 🔀
 
 # Host directory where database and user upload backups are stored
 BACKUP_DIR=./backups
 
-# Remote backup config (for use of backend/scripts/backup/backup_rclone.sh script)
-BACKUP_REMOTE_HOST=user@host
-BACKUP_REMOTE_PATH=/path/to/remote/backup
+# Remote rsync backup config (for use of backend/scripts/backup/rsync_backup.sh script)
+BACKUP_RSYNC_REMOTE_HOST=user@host              # 🔀
+BACKUP_RSYNC_REMOTE_PATH=/path/to/remote/backup # 🔀
+
+# Remote rclone backup config (for use of backend/scripts/backup/rclone_backup.sh script)
+BACKUP_RCLONE_REMOTE=myremote:/path/to/remote/backup # 🔀
+BACKUP_RCLONE_MULTI_THREAD_STREAMS=16
+BACKUP_RCLONE_TIMEOUT=5m
+BACKUP_RCLONE_USE_COOKIES=false

.github/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.1.0"
+}

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,33 @@
+---
+about: Report a bug
+assignees: ''
+labels: bug
+name: Bug report
+title: 'bug: '
+---
+
+## What happened?
+
+_Describe the bug in one or two sentences._
+
+## Environment
+
+_Only include details that help reproduce the issue._
+
+- _App area: backend / web / app_
+- _OS / browser / device_
+- _Version or build_
+
+## How to reproduce
+
+1. _Go to ..._
+1. _Do ..._
+1. _See the error_
+
+## What should happen?
+
+_Describe the expected behavior._
+
+## Anything else?
+
+_Add logs, screenshots, or a link to a failing run if useful._

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Contribution guide
+    url: https://github.com/CMLPlatform/relab/blob/main/CONTRIBUTING.md
+    about: Read this first if you need repo conventions, setup help, or contribution guidance.

.github/ISSUE_TEMPLATE/feature-request.md

@@ -1,18 +1,18 @@
 ---
-name: Feature request
-about: Suggest an idea for this project
-title: 'feature request: '
-labels: feature request
+about: Propose an improvement
 assignees: ''
+labels: feature request
+name: Feature request
+title: 'feature: '
 ---
 
-## Problem statement
+## Problem
 
-_A clear and concise description of the problem._
+_What are users trying to do, and what's getting in the way?_
 
 ## Proposed solution
 
-_A clear and concise description of what you want to happen._
+_Describe the smallest change that would solve it._
 
 ## Implementation ideas