Merge pull request #11 from hrueger/three

⚡️ improve three.js visualization

.eslintignore

@@ -13,4 +13,7 @@ package-lock.json
 yarn.lock
 
 # genrated files
-/public
+/public
+
+# downloaded files
+src/lib/udr.json

.eslintrc.cjs

@@ -26,5 +26,17 @@ module.exports = {
  parser: '@typescript-eslint/parser'
  }
  }
- ]
+ ],
+ rules: {
+ // note you must disable the base rule as it can report incorrect errors
+ 'no-unused-vars': 'off',
+ '@typescript-eslint/no-unused-vars': [
+ 'warn', // or "error"
+ {
+ argsIgnorePattern: '^_',
+ varsIgnorePattern: '^_',
+ caughtErrorsIgnorePattern: '^_'
+ }
+ ]
+ }
 };

.github/workflows/pipeline.yml

@@ -4,7 +4,7 @@ on: [push, pull_request]
 
 jobs:
  test:
- name: Test
+ name: Lint and Test
  runs-on: ubuntu-latest
  timeout-minutes: 15
 
@@ -21,6 +21,9 @@ jobs:
  run: |
  npm install
  npx playwright install
+ - name: Lint
+ run: |
+ npm run lint
  - name: Run tests
  run: |
  npm run test

.prettierignore

@@ -13,4 +13,7 @@ package-lock.json
 yarn.lock
 
 # genrated files
-/public
+/public
+
+# downloaded files
+src/lib/udr.json

README.md

@@ -2,19 +2,30 @@
 
 A new and intuitive way of controlling intelligent devices developed from first principles for the event industry.
 
-## prerequisites
+## 🚀 Contribute
+
+Feel free to check out the concepts here on GitHub, lets discuss your own ideas in [Issues](https://github.com/oshifty/vision/issues) or check out code you want to add via [Pull requests](https://github.com/oshifty/vision/pulls) 🥳
+
+- [Type Documentation](https://oshifty.github.io/vision) → checkout running [locally](http://localhost:8000) (`npm run doc`)
+- [WebSocket Demo](/src/routes/webSocketDemo) → checkout w/ running dev server: [/websocketDemo](http://localhost:5173/webSocketDemo)
+- [Visualizer](/src/routes/visualizer) → checkout w/ running dev server: [/visualizer](http://localhost:5173/visualizer)
+ - [Remote](/src/routes/visualizer/remote) → checkout w/ running dev server: [/visualizer/remote](http://localhost:5173/visualizer/remote)
+
+## 🔥 Run locally
+
+### prerequisites
 
 - [**Node.js®**](https://nodejs.org/) LTS
 
-## download
+### download
 
 This can either be done thru downloading the repos as [`*.zip`](https://github.com/LightYourWay/grandMA3-ts-template-plugin/archive/refs/heads/master.zip) and unpacking at said path or directly cloning the repository via cmdline.
 
 ```bash
 git clone https://github.com/oshifty/vision.git <path>
 ```
 
-## install dependencies
+### install dependencies
 
 Open the `<path>` in your IDE
 
@@ -28,43 +39,43 @@ and install all dependencies with `npm` in the terminal:
 npm install
 ```
 
-## run app for development
+### run app for development
 
 ```bash
 npm run dev
 ```
 
-## run tests for development
+### run tests for development
 
 ```bash
 npm run test
 ```
 
-## build documentation
+### build documentation
 
-### for development
+#### for development
 
 To build the documentation website for development and watch for file changes to automatically recompile run:
 
 ```bash
 npm run doc
 ```
 
-### for production
+#### for production
 
 To build your plugin for production run:
 
 ```bash
 npm run doc:build
 ```
 
-## lint
+### lint
 
 ```bash
 npm run lint
 ```
 
-## format
+### format
 
 ```bash
 npm run format