Merge pull request #8 from IPLSplatoon/release-070

0.7.0

.github/workflows/ci.yml

@@ -5,7 +5,7 @@ on:
   workflow_dispatch:
 
 jobs:
-  test:
+  lint:
     timeout-minutes: 30
     runs-on: ubuntu-latest
     steps:
@@ -28,13 +28,10 @@ jobs:
       - name: Run ESLint on source
         run: yarn lint
 
-      - name: Run tests
-        run: yarn test:unit
-
   build-publish:
     if: github.ref == 'refs/heads/master'
     timeout-minutes: 30
-    needs: test
+    needs: lint
     permissions:
       contents: write
     strategy:
@@ -71,7 +68,7 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          tagName: ncgmgr-v__VERSION__
+          tagName: v__VERSION__
           releaseName: "NCGMGR v__VERSION__"
           releaseDraft: true
           prerelease: false

README.md

@@ -6,8 +6,6 @@ NodeCG ManaGeR, built with [Tauri](https://tauri.app/) and Vue.js.
 
 ## Commands
 
-- `yarn test:unit` - Run tests
-- `yarn test:update` - Run tests and update snapshots
 - `yarn lint` - Run linter to check for errors in JS
 - `yarn lint:fix` - Fix automatically fixable linter errors
 - `yarn tauri build` - Build and bundle the application

docs/development.md

@@ -21,13 +21,6 @@ On macOS, the build will create a DMG package in the `src-tauri/target/release/b
 
 During development, use the `yarn tauri:serve` command to take advantage of hot-reloading and faster build times.
 
-## Tests
-
-NCGMGR has a suite of frontend tests running on the Jest framework.
-
-To run frontend tests, run `yarn test:unit`.  
-To run tests while updating snapshots, run `yarn test:update`.  
-
 ## Code style
 
 NCGMGR uses ESLint to automatically enforce a consistent code style. ESLint is run automatically by GitHub Actions

docs/requirements.txt

@@ -1,2 +1,2 @@
 mkdocs==1.3.0
-jinja2==3.0.0
+jinja2==3.1.3

docs/users-guide.md

@@ -29,34 +29,45 @@ NCGMGR needs Node.js to be installed to function. It will check for a Node.js in
 When a Node.js installation is not found, an alert will be displayed to the user. To download Node.js, visit its [website.](https://nodejs.dev/)
 The LTS version of Node.js is sufficient for the majority of users.
 
-### Installing a new copy of NodeCG
+## Installing a new copy of NodeCG
 
-![Message displayed when prompted to select an install directory](img/select-install-directory.png)
+![The application after it is first started](img/first-install.png)
 
-When a Node.js installation is found, you will be prompted to choose a directory to install NodeCG in.
-Click "Select folder" and pick a directory. In order to install NodeCG from scratch, select an empty directory.
-After selecting a suitable directory, click "Install" to start the installation process.
+When a Node.js installation is found, NCGMGR can either automatically select a directory and install NodeCG into it, 
+install NodeCG into a custom user directory or manage an existing installation of NodeCG.
 
-### Using an existing installation of NodeCG
-
-To use an existing installation of NodeCG, click "Select folder" and select the directory NodeCG was installed in.
-NCGMGR will automatically look for a NodeCG installation when a new install directory is selected.
-
-### Starting NodeCG
-
-After setting up a NodeCG installation, click on "Start" to start NodeCG. A log window will appear, showing any messages
-that appear while NodeCG is running. While NodeCG is running, click "Open dashboard" to open the NodeCG dashboard in a
-web browser. NodeCG may be stopped by clicking on the "Stop" button.
-
-## Managing bundles
+## Managing bundles and using NodeCG
 
+After NodeCG has been installed, the interface will display options to start and stop NodeCG and manage bundles. 
 A *bundle* in NodeCG contains graphics, dashboard panels and Node.js code (Extensions).
 
-![The bundle management interface](img/bundle-management.jpg)
+![The main application interface](img/main-view.png)
 
 ### Installing bundles
 
-Bundles can be installed from the following sources:
+Bundles can be installed by selecting "Add Bundle" in the main application window and typing one of the following as the
+repository path:
 
 - A GitHub username/repository name pair (`inkfarer/ipl-overlay-controls`)
 - A git repository URL (`https://github.com/inkfarer/ipl-overlay-controls.git`)
+
+## Settings
+
+![The application settings window](img/settings.png)
+
+Click the settings wrench along the top of the application window to access the settings page.
+
+### NodeCG status
+
+From the settings page, the currently selected NodeCG installation directory can be viewed. 
+Select "Change Install Folder" to return to the first-time setup page and select a different NodeCG installation or 
+install NodeCG again.
+
+### Dependency status
+
+The settings page displays the detected version of Node.js.
+
+### Error log
+
+The error log, when enabled, displays a list of errors that have occurred while the application is running. It can be 
+used to diagnose technical issues with NCGMGR itself.

package.json

@@ -1,12 +1,10 @@
 {
   "name": "ncgmgr",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "private": true,
   "scripts": {
     "dev": "vite",
     "build": "vite build",
-    "test:unit": "jest",
-    "test:update": "jest -u",
     "tauri": "tauri",
     "lint": "eslint --ext .js,.vue,.ts ./src",
     "lint:fix": "eslint --fix --ext .js,.vue,.ts ./src"
@@ -16,37 +14,32 @@
     "@fortawesome/free-solid-svg-icons": "^5.15.4",
     "@fortawesome/vue-fontawesome": "^3.0.0-5",
     "@iplsplatoon/vue-components": "3.2.0",
-    "@tauri-apps/api": "^1.5.3",
-    "@tauri-apps/cli": "^1.5.11",
+    "@tauri-apps/api": "2.0.0-beta.7",
+    "@tauri-apps/cli": "2.0.0-beta.12",
+    "@tauri-apps/plugin-dialog": "2.0.0-beta.2",
+    "@tauri-apps/plugin-fs": "2.0.0-beta.2",
+    "@tauri-apps/plugin-os": "2.0.0-beta.2",
+    "@tauri-apps/plugin-shell": "2.0.0-beta.2",
+    "@tauri-apps/plugin-store": "^2.0.0-beta.2",
     "anser": "^2.1.0",
     "lodash": "^4.17.21",
-    "node-gyp": "^10.1.0",
-    "pinia": "^2.0.11",
-    "vue": "^3.2.47"
+    "pinia": "^2.1.7",
+    "vue": "^3.4.21"
   },
   "devDependencies": {
-    "@pinia/testing": "^0.1.3",
-    "@types/hosted-git-info": "2.7.0",
-    "@types/jest": "^29.5.12",
     "@types/lodash": "^4.14.178",
     "@types/node": "^20.11.30",
     "@typescript-eslint/eslint-plugin": "^7.4.0",
     "@typescript-eslint/parser": "^7.4.0",
     "@vitejs/plugin-vue": "^5.0.4",
-    "@vue/compiler-sfc": "^3.0.0",
-    "@vue/test-utils": "^2.4.5",
-    "@vue/vue3-jest": "^29.2.6",
+    "@vue/compiler-sfc": "^3.4.21",
     "eslint": "^8.57.0",
     "eslint-plugin-vue": "^9.24.0",
-    "jest": "^29.7.0",
-    "jest-environment-jsdom": "^29.7.0",
     "sass": "^1.45.1",
-    "ts-jest": "^29.1.2",
     "tslib": "^2.6.2",
     "typescript": "~5.4.3",
     "vite": "^5.2.6",
-    "vite-tsconfig-paths": "^4.3.2",
-    "vue-jest": "^5.0.0-0"
+    "vite-tsconfig-paths": "^4.3.2"
   },
   "packageManager": "yarn@3.2.0"
 }

src-tauri/.gitignore

@@ -2,3 +2,4 @@
 # will have compiled files and executables
 /target/
 WixTools
+/gen/schemas