Vue frontend for Project area (and other stuff)

.github/workflows/main.yml

@@ -9,13 +9,14 @@ jobs:
 
     strategy:
       matrix:
-        java: [1.8, 1.11]
+        java: [8, 11, 17]
 
     env:
       PGPORT: 5432
       DB_USERNAME: postgres
       DB_PASSWORD: postgres
       DB_DATABASE: postgres
+      client-dir: ./oreClient
 
     services:
       postgres:
@@ -31,38 +32,21 @@ jobs:
           - 5432:5432
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Set up NodeJS
         uses: actions/setup-node@v3
         with:
           node-version: 16.16.0
+          cache: 'yarn'
+          cache-dependency-path: ${{env.client-dir}}/yarn.lock
 
       - name: Set up JDK
-        uses: actions/setup-java@v1
+        uses: actions/setup-java@v3
         with:
+          distribution: temurin
           java-version: ${{ matrix.java }}
-
-      - name: Cache sbt Ivy cache
-        uses: actions/cache@v1
-        with:
-          path: ~/.ivy2/cache
-          key: ${{ runner.os }}-sbt-ivy-cache-${{ hashFiles('**.sbt', 'project/**/*.scala') }}
-          restore-keys: ${{ runner.os }}-sbt-ivy-cache
-
-      - name: Cache sbt Coursier cache
-        uses: actions/cache@v1
-        with:
-          path: ~/.cache/coursier
-          key: ${{ runner.os }}-sbt-coursier-cache-${{ hashFiles('**.sbt', 'project/**/*.scala') }}
-          restore-keys: ${{ runner.os }}-sbt-coursier-cache
-
-      - name: Cache sbt
-        uses: actions/cache@v1
-        with:
-          path: ~/.sbt
-          key: ${{ runner.os }}-sbt-${{ hashFiles('**.sbt', 'project/**/*.scala', 'project/build.properties') }}
-          restore-keys: ${{ runner.os }}-sbt
+          cache: sbt
 
       - name: Initialize postgres extensions
         env:
@@ -75,6 +59,36 @@ jobs:
         run: |
           cp ore/conf/application.conf.template ore/conf/application.conf
           cp jobs/src/main/resources/application.conf.template jobs/src/main/resources/application.conf
+          cp oreClient/src/main/assets/config.json5.template oreClient/src/main/assets/config.json5
 
       - name: Run compile
         run: sbt "oreAll/compile;ore/test;ore/assets"
+
+  lintClient:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node: [14, 16]
+
+    env:
+      client-dir: ./oreClient
+
+    name: Client Linting (Node ${{ matrix.node }})
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
+          cache: 'yarn'
+          cache-dependency-path: ${{env.client-dir}}/yarn.lock
+
+      - name: Install dependencies
+        run: yarn install
+        working-directory: ${{env.client-dir}}
+
+      - name: Run linting
+        run: yarn run lint
+        working-directory: ${{env.client-dir}}

.github/workflows/scalafmt.yml

@@ -1,38 +1,38 @@
-name: Scalafmt Check
-
-on:
-  push:
-    paths:
-      - '**.scala'
-      - '**.sc'
-      - '**.sbt'
-  pull_request:
-    paths:
-      - '**.scala'
-      - '**.sc'
-      - '**.sbt'
-
-jobs:
-  check:
-
-    runs-on: ubuntu-latest
-
-    env:
-      VERSION: 2.4.2
-
-    steps:
-      - uses: actions/checkout@v2
-
-      #- name: Cache Scalafmt native image
-      #  id: cache
-      #  uses: actions/cache@v1
-      #  with:
-      #    path: scalafmt-native
-      #    key: ${{ runner.os }}-scalafmt-native-image-${{ hashFiles('scalafmt-native') }}
-
-      #- name: Download Scalafmt-native
-      #  if: steps.cache.outputs.cache-hit != 'true'
-      #  run: curl https://raw.githubusercontent.com/scalameta/scalafmt/master/bin/install-scalafmt-native.sh | bash -s -- $VERSION $GITHUB_WORKSPACE/scalafmt-native
-
-      - name: Check formatted
+name: Scalafmt Check
+
+on:
+  push:
+    paths:
+      - '**.scala'
+      - '**.sc'
+      - '**.sbt'
+  pull_request:
+    paths:
+      - '**.scala'
+      - '**.sc'
+      - '**.sbt'
+
+jobs:
+  check:
+
+    runs-on: ubuntu-latest
+
+    env:
+      VERSION: 2.4.2
+
+    steps:
+      - uses: actions/checkout@v4
+
+      #- name: Cache Scalafmt native image
+      #  id: cache
+      #  uses: actions/cache@v1
+      #  with:
+      #    path: scalafmt-native
+      #    key: ${{ runner.os }}-scalafmt-native-image-${{ hashFiles('scalafmt-native') }}
+
+      #- name: Download Scalafmt-native
+      #  if: steps.cache.outputs.cache-hit != 'true'
+      #  run: curl https://raw.githubusercontent.com/scalameta/scalafmt/master/bin/install-scalafmt-native.sh | bash -s -- $VERSION $GITHUB_WORKSPACE/scalafmt-native
+
+      - name: Check formatted
         run: ./scalafmt --check --non-interactive

.gitignore

@@ -183,6 +183,8 @@ local.properties
 node_modules
 
 # Ore
+oreClient/src/main/assets/config.json5
+oreClient/dist
 jobs/src/main/resources/application.conf
 ore/conf/application.conf
 /project/project/target
@@ -191,6 +193,7 @@ RUNNING_PID
 gradle
 .gradle
 build
+user.sbt
 
 # Hydra
 project/hydra.sbt

README.md

@@ -34,6 +34,8 @@ In a typical development environment, most of the defaults are fine. Here are a
 For `ore`:
 * You can disable authentication by setting `application.fakeUser` to `true`.
 
+You also need to create a copy of `oreClient/src/main/resources/assets/config.json5.template` named `config.json5`. Try to mirror the values you used in the `application.conf` file here.
+
 ## Running
 
 Running Ore is relatively simple.
@@ -61,3 +63,39 @@ For `jobs`:
 more stack size to sbt in the way you're starting sbt. `-Xss4m` should be enough. If you're using IntelliJ, you can set 
 this in the VM arguments field. If you're invoking sbt directly, the most common ways to set this is either through 
 the `SBT_OPTS` environment variable, or with a file named `.jvmopts` with each flag on a new line.
+
+### Running with Webpack dev server
+Play can be a bit slow to reload the application sometimes. Therefor it can be nice to instead use webpack's hot module 
+replacement. To do so, there are a few extra steps you need to go through.
+
+1. Comment out the line with `webpackMonitoredDirectories` in `build.sbt` (not needed, just for sanity with reloading)
+2. Add this to your `application.conf` under the filters section
+```
+cors {
+    allowedOrigins = ["http://localhost:8080"]
+}
+```
+3. If you want to see a logged in view, set `alwaysTryLogin` to `true` in `config.json5`
+4. Start Ore like normal
+5. Use `yarn run start` to start the webpack dev server
+6. Navigate to `http://localhost:8080`
+
+#### Disable webpack monitoring
+By default, Ore will monitor the frontend for changes and rebuilt it whenever it sees any. If you're running Ore with 
+the webpack server, this can be more of a hinderance. If you wish to disable it, add this to a new file 
+called `user.sbt` in the root folder.
+```scala
+lazy val setNoMonitoredFiles: State => State = { s: State =>
+  val projectID = "oreClient"
+  val value = Nil
+  if (Project.extract(s).get(LocalProject(projectID) / Assets / webpackMonitoredDirectories) == value)
+    s
+  else
+    s"""set (LocalProject("$projectID") / Assets / webpackMonitoredDirectories) := $value""" :: s
+}
+
+Global / onLoad := {
+  val old = (Global / onLoad).value
+  setNoMonitoredFiles compose old
+}
+```