Merge pull request #327 from openscript-ch/214-create-a-landing-page-for-the-project

214 create a landing page for the project

Author: openscript

.changeset/sour-snakes-knock.md

@@ -0,0 +1,5 @@
+---
+"@quassel/website": patch
+---
+
+Create initial version of landing page

.devcontainer/devcontainer.json

@@ -11,7 +11,8 @@
         "bierner.markdown-mermaid",
         "GitHub.vscode-pull-request-github",
         "DavidAnson.vscode-markdownlint",
-        "TheUMLetTeam.umlet"
+        "TheUMLetTeam.umlet",
+        "astro-build.astro-vscode"
       ]
     }
   },

.gitignore

@@ -227,3 +227,4 @@ dist
 
 .nx/cache
 .nx/workspace-data
+.astro/

.prettierrc.json

@@ -4,5 +4,14 @@
   "tabWidth": 2,
   "semi": true,
   "singleQuote": false,
-  "printWidth": 144
+  "printWidth": 144,
+  "plugins": ["prettier-plugin-astro"],
+  "overrides": [
+    {
+      "files": "*.astro",
+      "options": {
+        "parser": "astro"
+      }
+    }
+  ]
 }

.vscode/settings.json

@@ -16,12 +16,15 @@
   "[css]": {
     "editor.defaultFormatter": "vscode.css-language-features"
   },
+  "[astro]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
   "javascript.preferences.importModuleSpecifier": "relative",
   "typescript.preferences.importModuleSpecifier": "relative",
   "github.copilot.enable": {
     "*": true,
     "plaintext": false,
     "scminput": false,
     "markdown": true
-  }
+  },
 }

README.md

@@ -31,5 +31,6 @@ All parts of the project live inside this monorepo.
   - [`backend`](./apps/backend/)
   - [`frontend`](./apps/frontend/)
   - [`mockup`](./apps/mockup/)
+  - [`website`](./apps/website/)
 - Libs
   - [`ui`](./libs/ui/)

apps/website/.docker/nginx.conf

@@ -0,0 +1,31 @@
+worker_processes  1;
+
+events {
+  worker_connections  1024;
+}
+
+http {
+  server {
+    listen 80;
+    server_name   _;
+
+    root   /usr/share/nginx/html;
+    index  index.html index.htm;
+    include /etc/nginx/mime.types;
+
+    gzip on;
+    gzip_min_length 1000;
+    gzip_proxied expired no-cache no-store private auth;
+    gzip_types text/plain text/css application/json application/javascript application/x-javascript text/xml application/xml application/xml+rss text/javascript;
+
+    error_page 404 /404.html;
+    location = /404.html {
+            root /usr/share/nginx/html;
+            internal;
+    }
+
+    location / {
+            try_files $uri $uri/index.html =404;
+    }
+  }
+}

apps/website/Dockerfile

@@ -0,0 +1,14 @@
+FROM node:lts AS build
+
+WORKDIR /app
+COPY package*.json ./
+RUN npm install
+COPY . .
+RUN npm run build
+
+FROM docker.io/nginx:stable-alpine AS runtime
+
+COPY ./.docker/nginx.conf /etc/nginx/nginx.conf
+COPY --from=build /app/dist /usr/share/nginx/html
+
+EXPOSE 80

apps/website/README.md

@@ -0,0 +1,9 @@
+# Website
+
+## Resources
+
+- [Mockup](https://www.figma.com/design/OTh2qYuiYBC1tENZWveRhG/Quassel-landing-page?node-id=0-1&m=dev&t=lZbsgWJY6MOegek4-1)
+- [Icons](https://tabler.io/icons)
+- Frames
+  - [tablet](https://www.freepik.com/free-vector/digital-device-mockup-set_4394195.htm)
+  - [laptop](https://www.freepik.com/free-vector/digital-device-mockup_4249950.htm)

apps/website/astro.config.mjs

@@ -0,0 +1,18 @@
+// @ts-check
+import { defineConfig } from "astro/config";
+import Icons from "unplugin-icons/vite";
+
+// https://astro.build/config
+export default defineConfig({
+  server: {
+    port: 3003,
+  },
+
+  experimental: {
+    svg: true,
+  },
+
+  vite: {
+    plugins: [Icons({ compiler: "astro" })],
+  },
+});

apps/website/content/features/administration.yml

@@ -0,0 +1,16 @@
+- icon: "study-entry"
+  title: "Entry for studies"
+  description: "Allow administrators to create and manage questionnaire series and participants linked to specific studies."
+  screenshot: "study-entry.png"
+- icon: "data-management"
+  title: "Default data management"
+  description: "Store the data about carers' background information."
+  screenshot: "data-management.png"
+- icon: "export-data"
+  title: "Export raw data to CSV"
+  description: "The collected raw data are allowed to be exported into CSV or SQL formats."
+  screenshot: "export-data.png"
+- icon: "consolidate-data"
+  title: "Consolidate data into reports"
+  description: "Consolidate data into reports which contains participants ID and their language exposure information for further analysis."
+  screenshot: "consolidate-data.png"

apps/website/content/features/questionnaire.yml

@@ -0,0 +1,16 @@
+- icon: "calendar-week"
+  title: "Calendar interface"
+  description: "A dynamic weekly calendar interface that allows users to track, create, and modify overlapping language exposure entries."
+  screenshot: "calendar-interface.png"
+- icon: "time-period"
+  title: "Easy to select time period"
+  description: "A seamless time period selection feature allows users to define specific months or years for managing language exposure data."
+  screenshot: "time-period.png"
+- icon: "detect-gaps"
+  title: "Auto detect gaps"
+  description: "An automatic gap detection feature identifies missing language exposure periods, notifies users, and offers options to highlight or proceed despite gaps."
+  screenshot: "gap-detect.png"
+- icon: "recurring-entries"
+  title: "Recurring entries"
+  description: "Ability to create recurring entries for regular langage exposure events on weekly bases only (e.g. every second week)."
+  screenshot: "recurring-entry.png"

apps/website/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@quassel/website",
+  "type": "module",
+  "version": "0.0.1",
+  "scripts": {
+    "dev": "astro dev --host",
+    "prebuild": "astro check",
+    "build": "astro build",
+    "preview": "astro preview",
+    "astro": "astro"
+  },
+  "dependencies": {
+    "@fontsource-variable/montserrat": "^5.2.5",
+    "@fontsource-variable/onest": "^5.2.6",
+    "astro": "^5.5.3",
+    "reveal.js": "^5.2.0"
+  },
+  "devDependencies": {
+    "@astrojs/check": "^0.9.4",
+    "@iconify/json": "^2.2.318",
+    "@types/reveal.js": "^5.0.5",
+    "sharp": "^0.33.5",
+    "typescript": "^5.8.2",
+    "unplugin-icons": "^22.1.0"
+  }
+}

apps/website/project.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "name": "@quassel/website",
+  "targets": {
+    "container": {
+      "executor": "@nx-tools/nx-container:build"
+    }
+  }
+}