Upgrade dependencies, quickstart

Author: sezanzeb

backend/src/middlewares/logging-middleware.ts

@@ -0,0 +1,12 @@
+import { Middleware, ExpressMiddlewareInterface } from 'routing-controllers';
+
+@Middleware({ type: 'before' })
+export class LoggingMiddleware implements ExpressMiddlewareInterface {
+  use(request: any, response: any, next: (err: any) => any): void {
+    // TODO maybe remove this middleware, idk if I'll really need it.
+    //  Or maybe keep it but only do this if debugging is on.
+    //  But I'd want the proper logging object for this.
+    console.log('Incoming', request.method, request.url);
+    next(undefined);
+  }
+}

backend/src/services/unix-signal-service.ts

@@ -60,7 +60,11 @@ export class UnixSignalService implements IUnixSignalService {
     handler: ISignalHandler,
   ): Promise<void> {
     if (!this._handlers.has(signal)) {
-      this._handlers.set(signal, [() => process.exit()]);
+      this._handlers.set(signal, [() => {
+        // TODO I don't know why
+        console.error("process.exit", signal, handler)
+        process.exit()
+      }]);
 
       process.on(signal, () => this.handleSignal(signal));
     }

backend/tsconfig.json

@@ -5,8 +5,8 @@
     "experimentalDecorators": true,
     "importHelpers": true,
     "module": "commonjs",
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
     "outDir": "dist/",
     "strict": true,
     "target": "ES2022",

package.json

@@ -84,7 +84,7 @@
     "@types/react-dom": "^19.0.4",
     "@types/sha256": "^0.2.2",
     "@wojtekmaj/enzyme-adapter-react-17": "^0.6.1",
-    "bcrypt": "^5.0.0",
+    "bcrypt": "^6.0.0",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.0",
     "convict": "^6.0.0",

quickstart.md

@@ -0,0 +1,26 @@
+# Quickstart
+
+```sh
+# prep
+cp backend/.env.example backend/.env
+docker run --name backend --network host -v $(pwd):/app -w /app node:alpine yarn
+
+# start everything
+docker compose up db phpmyadmin maildev
+docker run --name backend --network host -v $(pwd):/app -w /app node:alpine sh \
+  -c "yarn backend::start"
+docker run --name frontend --network host -v $(pwd):/app -w /app node:alpine sh \
+  -c "API_BASE_URL='http://localhost:3000/api' yarn frontend::start" \
+```
+
+Visit http://localhost:8080/
+
+Edit code, frontend and backend restart automatically.
+
+
+# Quickstop
+
+```sh
+docker rm -f backend frontend
+docker compose down
+```