Test

.github/workflows/build-push.yml

@@ -0,0 +1,44 @@
+name: Build and push docker image to GHCR
+on:
+  workflow_run:
+    workflows: ["Tests"]
+    types:
+      - completed
+    branches: [main, test]
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Log in to container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: olabekkevold
+          password: ${{ secrets.PAT }}
+
+      - name: Determine image tag
+        id: tag
+        run: |
+          if: [ "${{ github.ref }}" == 'refs/heads/main' ]; then
+              echo "env_tag=latest" >> $GITHUB_OUTPUT
+            else
+                echo "env_tag=test" >> $GITHUB_OUTPUT
+            fi
+            ghcr.io/olabekkevold/labmanager:${{ github.sha }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v6
+        with:
+          context: ./labman
+          push: true
+          tags: |
+            ghcr.io/olabekkevold/labmanager:${{ steps.tag.outputs.env_tag }}
+            ghcr.io/olabekkevold/labmanager:${{ github.sha }}
+
+

.github/workflows/main.yml → .github/workflows/test.yml

@@ -1,9 +1,9 @@
 name: Tests
 on:
   push:
-    branches: [ main, develop ]
+    branches: [ main, develop, test ]
   pull_request:
-    branches: [ main, develop ]
+    branches: [ main, develop, test ]
 
 defaults:
   run:
@@ -59,7 +59,7 @@ jobs:
         env:
           NODE_ENV: test
           HOME: /root
-        run: npx playwright test
+        run: npx playwright test --project=firefox
       - uses: actions/upload-artifact@v4
         if: ${{ !cancelled() }}
         with:

.gitignore

@@ -27,6 +27,7 @@ yarn-error.log*
 # local env files
 .env*.local
 .env
+.env.production
 
 # vercel
 .vercel

README.md

@@ -1 +1,65 @@
-# LabManager
+# VR Lab Manager
+
+The purpose of this project of is to create system for organizing and managing equipment in addition to managing borrowing and returning of equipment.
+Initially made for the IMTEL VR Lab at NTNU but it is also usable for other inventories.
+
+## Features
+
+- Add edit and delete equipment
+- Manage borrowing and returning of equipment
+- Keep track of borrowers and equipment usage
+- Manage inventory administrators
+
+## Build and run your own instance
+
+### Requirements
+
+- A computer with Docker installed
+
+### Instructions
+
+1. Build a Docker image using the Dockerfile in ./labman. Run ``docker build -t labman .``
+2. Use the provided compose.yaml to run the application and make to make a .env file in the same directory containing the variables reqiored by compose.yaml.
+3. In compose.yaml, replace the labman image with name of the image you built in step 1.
+4. Start the application by running `docker compose up -d` in the same directory as compose.yaml
+5. Open `http://localhost:5000` and login with your own preferred credentials to start using the application
+
+## Develop
+
+### Database
+This project uses PostgreSQL as the database, using Prisma as the ORM.
+
+1. Create a PostgreSQL database using your preferred method
+2. Make an .env file with the database connection string: `DATABASE_URL=postgres://{username}:{password}@{route}/{database}?schema=public
+
+### Run the application
+
+1. Clone the repository
+2. Run `cd labman`
+3. Run `npm install`
+4. Run `npm prisma generate` to generate the Prisma client
+5. Run `npm prisma migrate dev` to run the database migrations
+6. Run `npm run dev` to start the development server
+7. Open `http://localhost:3000` and login with your own preferred credentials to make a user to access the application
+
+
+# FAQ
+
+- **Can I use this application for managing other types of inventory?**
+
+Yes, the current name is misleading. The application is perfectly suitable for other things than VR equipment too.
+
+- **I forgot the credentials to my accounts?**
+
+As of now, there is no way to recover lost accounts. If no one has access to create a new account for you, you can directly manipulate the database to delete all users,
+which will force the creation of a new account on the next login attempt.
+
+- **Is it safe to store sensitive information in the database?**
+
+Everything is hosted locally with no external connections, and the login passwords are encrypted. Though if you are hosting the application publicly, it is your own responsibility to host it securely.
+
+
+
+
+
+

compose.yaml

@@ -0,0 +1,45 @@
+services:
+  labman:
+    image: ghcr.io/olabekkevold/labmanager:latest
+    environment:
+      DATABASE_URL:
+    ports:
+      - "5000:3000"
+    restart: "unless-stopped"
+    depends_on:
+      db:
+        condition: service_healthy
+
+  db:
+    image: postgres:18
+    restart: always
+    # set shared memory limit when using docker compose
+    shm_size: 128mb
+    # or set shared memory limit when deploy via swarm stack
+    #volumes:
+    #  - type: tmpfs
+    #    target: /dev/shm
+    #    tmpfs:
+    #      size: 134217728 # 128*2^20 bytes = 128Mb
+    environment:
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
+      POSTGRES_USER: ${POSTGRES_USER}
+    ports:
+      - "5432:5432"
+    volumes:
+      - postgres_data:/var/lib/postgresql
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U ${POSTGRES_USER}"]
+      interval: 5s
+      timeout: 5s
+      retries: 5
+
+  adminer:
+    image: adminer
+    restart: always
+    ports:
+      - 8080:8080
+
+
+volumes:
+    postgres_data:

labman/.gitignore

@@ -32,6 +32,7 @@ yarn-error.log*
 
 # env files (can opt-in for committing if needed)
 .env
+.env.production
 
 # vercel
 .vercel
@@ -42,6 +43,8 @@ next-env.d.ts
 
 /src/generated/prisma
 
+.idea
+
 # Playwright
 node_modules/
 /test-results/

labman/Dockerfile

@@ -0,0 +1,75 @@
+# syntax=docker.io/docker/dockerfile:1
+
+FROM node:20-alpine AS base
+
+# Install dependencies only when needed
+FROM base AS deps
+# Check https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
+RUN apk add --no-cache libc6-compat
+WORKDIR /app
+
+# Install dependencies based on the preferred package manager
+COPY package.json yarn.lock* package-lock.json* pnpm-lock.yaml* .npmrc* ./
+RUN \
+  if [ -f yarn.lock ]; then yarn --frozen-lockfile; \
+  elif [ -f package-lock.json ]; then npm ci; \
+  elif [ -f pnpm-lock.yaml ]; then corepack enable pnpm && pnpm i --frozen-lockfile; \
+  else echo "Lockfile not found." && exit 1; \
+  fi
+
+
+# Rebuild the source code only when needed
+FROM base AS builder
+WORKDIR /app
+COPY --from=deps /app/node_modules ./node_modules
+COPY . .
+
+# Next.js collects completely anonymous telemetry data about general usage.
+# Learn more here: https://nextjs.org/telemetry
+# Uncomment the following line in case you want to disable telemetry during the build.
+# ENV NEXT_TELEMETRY_DISABLED=1
+
+RUN npx prisma generate
+
+RUN npm run build;
+
+# Production image, copy all the files and run next
+FROM base AS runner
+WORKDIR /app
+
+
+# Uncomment the following line in case you want to disable telemetry during runtime.
+# ENV NEXT_TELEMETRY_DISABLED=1
+
+RUN addgroup --system --gid 1001 nodejs
+RUN adduser --system --uid 1001 nextjs
+
+COPY --from=builder /app/public ./public
+
+# Automatically leverage output traces to reduce image size
+# https://nextjs.org/docs/advanced-features/output-file-tracing
+COPY --from=builder --chown=nextjs:nodejs /app/.next/standalone ./
+COPY --from=builder --chown=nextjs:nodejs /app/.next/static ./.next/static
+
+COPY --from=builder --chown=nextjs:nodejs /app/prisma ./prisma
+
+COPY --chown=nextjs:nodejs docker-entrypoint.sh .
+# Make sure the entrypoint is in Unix format
+RUN apk add --no-cache dos2unix && \
+   dos2unix docker-entrypoint.sh && \
+   chmod +x docker-entrypoint.sh
+
+RUN npm install -g prisma@6.19.2
+
+USER nextjs
+
+EXPOSE 3000
+
+ENV PORT=3000
+
+# server.js is created by next build from the standalone output
+# https://nextjs.org/docs/pages/api-reference/config/next-config-js/output
+ENV HOSTNAME="0.0.0.0"
+
+ENTRYPOINT ["./docker-entrypoint.sh"]
+CMD ["node", "server.js"]

labman/docker-entrypoint.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+set -e
+
+prisma migrate deploy
+
+exec "$@"

labman/eslint.config.mjs

@@ -9,8 +9,9 @@ const compat = new FlatCompat({
   baseDirectory: __dirname,
 });
 
-const eslintConfig = [
+// Commented out because it is too strict for auto-generated files from other dependencies
+/* const eslintConfig = [
   ...compat.extends("next/core-web-vitals", "next/typescript"),
 ];
 
-export default eslintConfig;
+export default eslintConfig; */

labman/next.config.ts

@@ -2,6 +2,7 @@ import type { NextConfig } from "next";
 
 const nextConfig: NextConfig = {
   /* config options here */
+    output: "standalone",
 };
 
 export default nextConfig;