Trigger new ghcr package release

.dockerignore

@@ -0,0 +1,46 @@
+# To test that this file is actually working,
+# follow the steps here to make an image with the files: https://stackoverflow.com/a/40966234
+# then run a container from that image and look at its logs to see what's in there.
+
+**/.git
+
+**/__pycache__
+
+/build
+/node_modules
+/.svelte-kit
+
+/.github
+/.vscode
+
+/docs
+
+# We do not currently run tests from the container. Will need to uncomment this if we do that.
+/tests
+
+LICENSE
+README.md
+start.py
+cspell.json
+
+**/.classpath
+**/.dockerignore
+**/.env
+**/.gitignore
+**/.project
+**/.settings
+**/.toolstarget
+**/.vs
+**/*.*proj.user
+**/*.dbmdl
+**/*.jfm
+**/charts
+**/docker-compose*
+**/compose*
+**/Dockerfile*
+**/npm-debug.log
+**/obj
+**/secrets.dev.yaml
+**/values.dev.yaml
+**/.tests
+**/.jest.config.ts

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Report a bug you encountered
+type: bug
+
+---
+
+**Bug Description**
+Please give a high-level overview of the bug.
+
+**Steps To Reproduce**
+List the steps you took so we can reproduce the bug. Please be specific as it is often small details that produce bugs.
+
+**Expected Behavior**
+What did you expect to happen?
+
+**Actual Behavior**
+What actually happened?
+
+**Screenshots**
+If applicable, add screenshots that show the problem.
+
+**If the bug occurs on desktop, please complete the following information:**
+
+- OS: (e.g. macOS, Windows)
+- Browser (e.g. Chrome, Firefox, Safari)
+- Version (e.g. 22)
+
+**If the bug occurs on mobile, please complete the following information:**
+
+- Device: (e.g. iPhone 16, Samsung S24)
+- OS: (e.g. iOS 18, android 15)
+- Browser (e.g. Chrome, Firefox, Safari)
+- Version (e.g. 22)
+
+**Additional Information**
+If you have any other information about the problem, please add it here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,15 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+type: feature
+
+---
+
+**Feature Description**
+Please give a brief overview of the desired feature
+
+**Preferred Solution**
+If you have a particular idea for a solution or one you prefer, please describe it here
+
+**Additional Information**
+If you have any other information you think might be useful, please add it here.

.github/assetatlas/ConfiguringOauthProviders.md

@@ -0,0 +1,42 @@
+# Configuring OAuth for Asset Atlas
+
+One of the app’s features is the ability to have users create and login to their own accounts, which can be done with Google and Github accounts. Unfortunately this must be manually configured for every instance of Asset Atlas, but is not too difficult of a task.
+
+The rough outline of this process is:
+
+1. Configure OAuth logins for Google and Github
+2. Create "secrets.env" in the app directory
+3. Insert needed data into "secrets.env"
+
+## 1. Configuring OAuth logins for Google and Github
+
+   OAuth is a process that allows users to login to the app using external accounts, namely Github and Google in this case. In order to have these function properly, you will need to register an app with these providers, which will let them know where the user is trying to log in to.
+
+1) Google OAuth Registration (read fully before starting)
+   1) Read the [official Google documentation](https://support.google.com/cloud/answer/15549257?sjid=2068013545075202076-NC) for the actual process of creating the cloud client
+   2) When you are registering, you will be prompted for "Authorized redirect URIs". This will be what brings us back to the application once google has logged the user in, and you will need to provide this link. The actual link you give may differ, but it will take the form of `**(home page)**/api/oauth/callbackGoogle`. So if you are hosting the app locally at <http://localhost:3000>, the URI should be `http://localhost:3000/api/oauth/callbackGoogle`.
+   3) The end result of the registration process will be a client ID and a client secret. Hold onto these and save them for later, particularly the secret, as you can only look at it once.
+
+2) Github OAuth Registration (read fully before starting)
+   1) Read the [official GitHub documentation](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) for the process of registering an OAuth app with GitHub
+   2) When you are registering, you will be prompted for "Homepage URL". This is just the link where your main page lies. For example if locally hosted at `http://localhost:3000`, this is where the main page would lie.
+   3) You will also be prompted for an "Authorization callback URL". This will be the home page url \+ `/api/oauth/callbackGithub`, so `http://localhost:3000/api/oauth/callbackGithub` if following the previous example.
+   4) The end result of the registration process will be a client ID and a client secret. Hold onto these and save them for later, particularly the secret, as you can only look at it once.
+
+## 2. Creating `secrets.env` in the app folder
+
+Now that you have the data needed, you will need to have somewhere to store it so that the app can use it.
+
+1) Navigate to the folder where you downloaded your app. This should be the same folder that holds `docker-compose-ghcr.yml`
+2) Create a new file in this folder, and name it `secrets.env`
+
+## 3. Adding data to `secrets.env`
+
+Now that we have the file, we need to add the data to it.
+
+1. Open `secrets.env` with a text editor
+2. Visit the [docker/secrets.env.example](https://github.com/AssetAtlasTracker/AssetAtlas/blob/main/docker/secrets.env.example) on GitHub
+3. Copy the example text into your file
+4. Update all fields as needed with the data you got from registering the OAuth apps
+
+Once this is complete, users should be able to login with OAuth.

.github/assetatlas/README.md

@@ -67,4 +67,8 @@ docker compose -f docker-compose-ghcr.yml down
 
 # Tailscale
 docker compose -f docker-compose-ghcr-tailscale.yml down
-```
+```
+
+## Also
+
+See [ConfiguringOauthProviders.md](./ConfiguringOauthProviders.md) for instructions on how to set up OAuth providers to allow users to log in and log out of their accounts

.github/assetatlas/docker-compose-ghcr-tailscale.yml

@@ -7,6 +7,7 @@ services:
     volumes:
       - assetatlas-config:/usr/src/app/config
       - assetatlas-tsbuild-cache:/usr/src/app/.tsbuildcache
+    env_file: secrets.env
     environment:
       NODE_ENV: production
       MONGO_URI: mongodb://mongo:27017/assetatlas_db
@@ -27,6 +28,15 @@ services:
     networks:
       - assetatlas-network
 
+  auto-migration:
+    image: ${DOCKER_IMAGE:-ghcr.io/assetatlastracker/assetatlas:latest}
+    pull_policy: always
+    depends_on:
+      - mongo
+    command: ["npx", "migrate-mongo", "up", "-f", "migrate-mongo-docker-config.cjs"]
+    environment:
+      MONGO_URI: mongodb://mongo:27017/assetatlas_db
+
   tailscale:
     image: tailscale/tailscale:stable
     container_name: assetatlas-ts

.github/assetatlas/docker-compose-ghcr.yml

@@ -7,6 +7,7 @@ services:
     volumes:
       - assetatlas-config:/usr/src/app/config
       - assetatlas-tsbuild-cache:/usr/src/app/.tsbuildcache
+    env_file: secrets.env
     environment:
       NODE_ENV: production
       MONGO_URI: mongodb://mongo:27017/assetatlas_db
@@ -27,6 +28,16 @@ services:
     networks:
       - assetatlas-network
 
+  auto-migration:
+    image: ${DOCKER_IMAGE:-ghcr.io/assetatlastracker/assetatlas:latest}
+    pull_policy: always
+    depends_on:
+      - mongo
+    command: ["npx", "migrate-mongo", "up", "-f", "migrate-mongo-docker-config.cjs"]
+    environment:
+      MONGO_URI: mongodb://mongo:27017/assetatlas_db
+
+
 networks:
   assetatlas-network:
     driver: bridge

.github/workflows/docker-publish.yml

@@ -2,7 +2,7 @@ name: Build and Publish Docker Images
 
 on:
   push:
-    branches: 
+    branches:
       - production
   pull_request:
     branches:
@@ -56,5 +56,7 @@ jobs:
           platforms: linux/amd64,linux/arm64
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            APP_VERSION=${{ format('{0} ({1})', steps.meta.outputs.version, github.sha) }}
           cache-from: type=gha
-          cache-to: type=gha,mode=max
+          cache-to: type=gha,mode=max

.github/workflows/release-ghcr-files.yml

@@ -2,36 +2,37 @@ name: Create Release with Docker Files
 
 on:
   push:
-    branches: 
+    branches:
       - production
     paths:
-      - '.github/assetatlas/**'
-      - '.github/workflows/release-ghcr-files.yml'
+      - ".github/assetatlas/**"
+      - ".github/workflows/release-ghcr-files.yml"
   workflow_dispatch:
 
 jobs:
   create-release:
     runs-on: ubuntu-latest
     permissions:
       contents: write
-    
+
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
-        
+
       - name: Set up directory structure
         run: |
           mkdir -p release-files
-          cp .github/assetatlas/README.md release-files/
+          cp .github/assetatlas/README.release.md release-files/README.md
+          cp .github/assetatlas/ConfiguringOauthProviders.md release-files/
           cp .github/assetatlas/docker-compose-ghcr.yml release-files/
           cp .github/assetatlas/docker-compose-ghcr-tailscale.yml release-files/
-          
+
       - name: Create ZIP archive
         run: |
           cd release-files
           zip -r ../assetatlas-ghcr-files.zip .
           cd ..
-      
+
       - name: Create/Update Release
         id: create_release
         uses: softprops/action-gh-release@v1
@@ -41,17 +42,19 @@ jobs:
           files: |
             assetatlas-ghcr-files.zip
             release-files/README.md
+            release-files/ConfiguringOauthProviders.md
             release-files/docker-compose-ghcr.yml
             release-files/docker-compose-ghcr-tailscale.yml
           draft: false
           prerelease: false
           body: |
             # AssetAtlas GHCR Files
-            
+
             This release contains the necessary files to run AssetAtlas using Docker:
-            
+
             - README.md - Instructions for running the containers
+            - ConfiguringOauthProviders.md - Guide for setting up OAuth providers
             - docker-compose-ghcr.yml - For runing locally
             - docker-compose-ghcr-tailscale.yml - For running with Tailscale networking
-            
+
             You can download either the individual files or the complete ZIP archive.

.github/workflows/test.yml

@@ -1,31 +1,47 @@
-name: Run Tests and Lint
+name: Run Lint and Tests with Coverage
 
 on:
   push:
-    branches:
-      - main
+    branches: ["main"]
   pull_request:
-    branches:
-      - main
+    branches: ["main"]
 
 jobs:
   test:
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: '20'
+          node-version: "22.x"
+          cache: "npm"
 
       - name: Install dependencies
-        run: rm package-lock.json && npm install
-
-      - name: Run tests
-        run: npm run test
+        run: npm ci
 
       - name: Run lint
         run: npm run lint
+
+      - name: Run tests with coverage
+        run: npm run coverage
+
+      - name: Upload Coverage Report
+        uses: actions/upload-artifact@v4
+        with:
+          name: Coverage Report
+          path: coverage/
+          if-no-files-found: error
+
+      - name: Run component tests with coverage
+        run: npm run coverage:comp
+
+      - name: Upload Components Coverage Report
+        uses: actions/upload-artifact@v4
+        with:
+          name: Components Coverage Report
+          path: coverage/
+          if-no-files-found: error