Merge development into main

.github/workflows/deployDev.yml

@@ -18,4 +18,4 @@ jobs:
 
       - name: Deploy to server
         run: |
-          ssh -o StrictHostKeyChecking=no gh-actions@ssh.icinoxis.net -p 22137 'bash -s' < ./scripts/deployDevNestjs.sh
+          ssh -o StrictHostKeyChecking=no -p ${{ secrets.AZURE_SSH_PORT }} ${{ secrets.AZURE_SSH_USER }}@${{ secrets.AZURE_SSH_HOST }} 'bash -s' < ./scripts/deployDevNestjs.sh

.github/workflows/deployMain.yml

@@ -18,4 +18,4 @@ jobs:
 
       - name: Deploy to server
         run: |
-          ssh -o StrictHostKeyChecking=no brainet@142.93.175.194 'bash -s' < ./scripts/deployMainNestjs.sh
+          ssh -o StrictHostKeyChecking=no -p ${{ secrets.AZURE_SSH_PORT }} ${{ secrets.AZURE_SSH_USER }}@${{ secrets.AZURE_SSH_HOST }} 'bash -s' < ./scripts/deployMainNestjs.sh

.github/workflows/test.yml

@@ -12,20 +12,41 @@ jobs:
         options: --health-cmd="exit 0" # Disable health check to avoid flakiness
         ports:
           - 27017:27017
-        timeout: 300s # Increase timeout
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          token: ${{ secrets.GH_PAT }}
 
       - name: Set up Node.js
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
         with:
-          node-version: '14'
+          version: 9
 
       - name: Install dependencies
-        run: npm install
+        run: pnpm install --force
+
+      # - name: approve builds
+      #   run: pnpm approve-builds <<< a <<< y
+
+      - name: pwd
+        run: pwd
+
+      - name: ls
+        run: ls node_modules
+
+      - name: ls
+        run: ls node_modules/.pnpm/
 
       - name: Run tests
-        run: npm test
-        retry: 3 # Add retry logic
+        run: pnpm test
+
+      - name: Test build
+        run: pnpm build

.gitignore

@@ -1,6 +1,7 @@
 # custom
 .vscode/
 dataStorage/
+.idea
 
 # Logs
 logs

.husky/pre-push

@@ -1 +1,5 @@
-jest --bail
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+# Disabled pre-push tests.
+exit 0

README.md

@@ -1,24 +1,120 @@
 # Backmind
 
+Backmind is the API backend for the Whitemind product. It is built with
+NestJS, Fastify, and MongoDB and provides authentication, projects, tasks,
+tutorials, and user features.
+
+## Quick start
+
 ```sh
-npm install
-npm start dev
+pnpm install
+pnpm dev
 ```
 
-Beispiel für .env:
+The server starts on `http://localhost:3000` by default.
+
+## Requirements
+
+- Node.js 20+ (LTS recommended)
+- pnpm
+- MongoDB (Atlas or local)
+
+## Configuration
+
+Backmind reads configuration from `.env`. Use the values below as a starting
+point and update secrets for your environment.
 
 ```sh
-MONGO_URI='mongodb://user:password@host'
-SENDGRID_API_KEY='SG.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
-BACKMIND_HOSTNAME='http://localhost:3000/'
-WHITEMIND_HOSTNAME='http://localhost:8000/'
-JWT_TOKEN_EXPIRE_IN="24h"
-DB_NAME="backmind-dev"
-JWT_SECRET="xxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-SEND_ERR_TO_CLIENT="true"
-LOG_LEVEL="debug"
-NODE_ENV="development"
-DISABLE_ACCOUNT_CREATION="false"
-VERIFY_ALL_EMAILS="true"
-MAX_PFP_SIZE="1024"
+# Core
+MONGO_URI=mongodb://user:password@host
+DB_NAME=backmind-dev
+NODE_ENV=development
+HOST=0.0.0.0
+PORT=3000
+
+# Auth
+JWT_SECRET=change_me
+JWT_TOKEN_EXPIRE_IN=24h
+SECRET_KEY=change_me
+SALT_ROUNDS=10
+MIN_PASS_LENGTH=6
+
+# Account / limits
+VERIFY_ALL_EMAILS=true
+DISABLE_ACCOUNT_CREATION=false
+MAX_TOKENS=5
+RATE_LIMIT_DURATION=5
+RATE_LIMIT_REQUESTS=1000
+
+# Email / notifications
+SENDGRID_API_KEY=SG.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+EMAIL_VERIFICATION_TOKEN_VALID_MINUTES=60
+
+# App URLs
+BACKMIND_HOSTNAME=http://localhost:3000/
+WHITEMIND_HOSTNAME=http://localhost:8000/
+
+# Files
+FILES_DIRECTORY=./dataStorage
+PFP_DIRECTORY=./dataStorage/pfp
+MODEL_DIRECTORY=./dataStorage/model
+
+# Logging
+LOG_LEVEL=debug
+DISCORD_LOGGING=true
+SEND_ERR_TO_CLIENT=true
+
+# Dev helpers
+RESET_DB=
+WRITE_PROJECT_JSON=false
 ```
+
+Notes:
+
+- `SECRET_KEY` is used by `@fastify/secure-session` and must decode to 32 bytes
+  if provided as base64.
+- `JWT_SECRET` and `SECRET_KEY` should be unique per environment.
+
+## Common scripts
+
+```sh
+pnpm dev           # Run in watch mode
+pnpm build         # Build to dist/
+pnpm test          # Run tests
+pnpm lint          # Lint and auto-fix
+pnpm dropDb        # Drop the database (see scripts/dropDb.js)
+pnpm createTutorials  # Seed tutorials (requires TutorMind data)
+```
+
+## Seeding tutorials
+
+Tutorial data lives in the `TutorMind` submodule. Ensure it is available
+before running:
+
+```sh
+pnpm createTutorials
+```
+
+If the submodule is private, clone it with appropriate credentials.
+
+## Deployment
+
+GitHub Actions workflows live in `.github/workflows/` and deploy via SSH by
+running the scripts in `scripts/`.
+
+- `scripts/deployMainNestjs.sh`
+- `scripts/deployDevNestjs.sh`
+
+These scripts install dependencies, build, and restart the server.
+
+## Tech stack
+
+- NestJS
+- Fastify
+- Mongoose
+- JWT auth
+- SendGrid
+
+## License
+
+UNLICENSED