Merge remote-tracking branch 'origin/main' into feature/workflow-tests

# Conflicts:
#	package.json
#	pnpm-lock.yaml

README.md

@@ -1,5 +1,30 @@
 # chalmers.it
-A to-be rewrite of [chalmersit-rails](https://github.com/cthit/chalmersit-rails)
+An ongoing rewrite of [chalmersit-rails](https://github.com/cthit/chalmersit-rails) in Next.js
 
-## Suggestions
-Suggestions are very welcome, and if you wish to create one, please create an issue and tag it with the `suggestion` label.
+## Suggestions and Contributions
+Suggestions are very welcome, and if you wish to create one, please create an issue using one of the templates.
+Contributions are also welcome, feel free to create a pull request with your changes.
+
+# Building and running
+
+## Prerequisites
+A few things are required to run the project:
+1. [Node.js](https://nodejs.org/en/) v20 for running the web server
+2. Docker for running other services
+3. pnpm (installed with `npm install -g pnpm`)
+
+## Running in development
+1. Install packages with `pnpm install`
+2. Start services by running `docker-compose -f docker-compose.dev.yml up -d`
+3. Set up the database by running `pnpm prisma generate` and `pnpm prisma db push`
+4. Run `pnpm run dev` to start the development server
+
+## Production use
+
+The easiest to run the project in production mode is to use the docker-compose file in the root of the project.
+This will start all the services needed, and expose the web server on port 3000.
+
+The project can also be compiled into a minimized file structure, which can be run with just Node.
+This is done by running `pnpm run build`, which will build the project to `.next/standalone`.
+Services will however be needed to be started separately.
+The project is also compiled this way when building the docker image.

package.json

@@ -13,22 +13,22 @@
     "@prisma/client": "^5.4.2",
     "ansis": "^1.5.6",
     "colorette": "^2.0.20",
+    "next": "14.0.3",
     "jest": "^29.7.0",
-    "next": "13.5.4",
     "next-logger": "^3.0.2",
     "next-themes": "^0.2.1",
     "pino": "^8.16.0",
     "pino-pretty": "^10.2.3",
-    "react": "^18.2",
-    "react-dom": "^18.2",
+    "react": "^18",
+    "react-dom": "^18",
     "react-icons": "^4.12.0"
   },
   "devDependencies": {
     "@types/node": "^20",
-    "@types/react": "^18.2",
-    "@types/react-dom": "^18.2",
+    "@types/react": "^18",
+    "@types/react-dom": "^18",
     "eslint": "^8",
-    "eslint-config-next": "13.5.4",
+    "eslint-config-next": "14.0.3",
     "eslint-plugin-unused-imports": "^3.0.0",
     "prisma": "^5.4.2",
     "sass": "^1.69.1",