Setup electron

.env

@@ -1 +1,4 @@
-VUE_APP_DMX2WS_SERVER_URL=127.0.0.1:5214
+VITE_APP_DMX2WS_SERVER_URL="127.0.0.1:5214"
+VITE_DEV_SERVER_URL="http://localhost:5173"
+VITE_STATIC_URL=""
+WSC_VERSION="2.2.0-rc.6"

.eslintrc.js

@@ -0,0 +1,38 @@
+module.exports = {
+  extends: [
+    'airbnb-base',
+    'eslint:recommended',
+    'plugin:vue/vue3-recommended',
+  ],
+  env: {
+    browser: true,
+    node: true,
+    es2021: true,
+  },
+  parserOptions: {
+    ecmaVersion: 'latest',
+  },
+  rules: {
+    'vue/no-mutating-props': ['error', {
+      shallowOnly: true,
+    }],
+    'no-plusplus': 'off',
+    'no-underscore-dangle': 'off',
+    'max-classes-per-file': 'off',
+    'no-constructor-return': 'off',
+    'no-param-reassign': 'off',
+    'no-await-in-loop': 'off',
+    camelcase: 'off',
+  },
+  settings: {
+    'import/resolver': {
+      alias: {
+        map: [
+          ['@', './src'],
+          ['@root', './'],
+        ],
+        extensions: ['.js', '.vue'],
+      },
+    },
+  },
+};

.github/workflows/deploy.app.yaml

@@ -0,0 +1,36 @@
+name: Deploy
+
+on:
+  push:
+    branches: [staging]
+
+permissions:
+  contents: read # for checkout
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    # This is due to change for different envs but
+    # as of today we only have one deployment endpoint (demo)
+    if: github.ref == 'refs/heads/staging'
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16.x'
+      - name: Install npm dependencies
+        run: npm install
+      - name: Run build task
+        run: npm run build --if-present
+      - name: Deploy to Server
+        uses: easingthemes/ssh-deploy@main
+        with:
+          SSH_PRIVATE_KEY: ${{ secrets.SERVER_SSH_PRIVATE_KEY }}
+          ARGS: '-rlgoDzvc -i --delete'
+          SOURCE: 'dist/'
+          REMOTE_HOST: ${{ secrets.SERVER_REMOTE_HOST }}
+          REMOTE_USER: ${{ secrets.SERVER_REMOTE_USER }}
+          TARGET: ${{ secrets.STUDIO_APP_SERVER_REMOTE_TARGET }}
+          EXCLUDE: '/dist/, /node_modules/'

.github/workflows/deploy.docs.yaml

@@ -0,0 +1,36 @@
+name: Deploy
+
+on:
+  push:
+    branches: [master, staging]
+
+permissions:
+  contents: read # for checkout
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    # This is due to change for different envs but
+    # as of today we only have one deployment endpoint (demo)
+    if: github.ref == 'refs/heads/staging'
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16.x'
+      - name: Install npm dependencies
+        run: npm run docs:manual:build
+      - name: Run build task
+        run: npm run build --if-present
+      - name: Deploy to Server
+        uses: easingthemes/ssh-deploy@main
+        with:
+          SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
+          ARGS: '-rlgoDzvc -i --delete'
+          SOURCE: './docs/manual/.vitepress/dist/'
+          REMOTE_HOST: ${{ secrets.REMOTE_HOST }}
+          REMOTE_USER: ${{ secrets.REMOTE_USER }}
+          TARGET: ${{ secrets.REMOTE_TARGET }}
+          EXCLUDE: '/dist/, /node_modules/'

.github/workflows/release.yaml

@@ -0,0 +1,29 @@
+name: Release
+
+on:
+  push:
+    branches: [ master, staging ]
+
+permissions:
+  contents: read # for checkout
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # to be able to publish a GitHub release
+      id-token: write # to enable use of OIDC for npm provenance
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "lts/*"
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: npx semantic-release

.gitignore

@@ -21,5 +21,13 @@ yarn-error.log*
 *.sln
 *.sw?
 
+# Electron output
+/out
+
 #Electron-builder output
-/dist_electron
+/dist_electron
+
+# Vitepress
+**/.vitepress/cache
+
+**/bin/

README.md

@@ -1,86 +1,88 @@
-[![MadeWithVueJs.com shield](https://madewithvuejs.com/storage/repo-shields/4381-shield.svg)](https://madewithvuejs.com/p/asls-studio/shield-link)
-# What is ASLS Studio
+<p align="center">
+  <a href="https://studio.asls.io/" target="blank"><img src="./src/assets/images/studio_logo_textual.svg" height="100" alt="ASLS Studio logo" /></a>
+  <p align="center">Open source, web-based, show control software and visualizer </p>
+</p>
 
-[ASLS Studio](https://studio.asls.timekadel.com) is an open-source, web-based, DMX lighting control software and visualizer.
+<p align="center">
+  <a href="https://madewithvuejs.com/p/asls-studio/shield-link" target="_blank">
+    <img src="https://madewithvuejs.com/storage/repo-shields/4381-shield.svg" alt="MadeWithVueJs.com shield" />
+  </a>
+  <a href="https://github.com/ASLS-org/studio/?tab=GPL-3.0-1-ov-file" target="_blank">
+    <img src="https://img.shields.io/github/license/asls-org/studio" alt="License" />
+  </a>
+  </a>
+  <a href="https://github.com/ASLS-org/studio/releases" target="_blank">
+    <img src="https://img.shields.io/github/v/tag/asls-org/studio?include_prereleases&sort=semver&style=flat&label=version" alt="Version" />
+  </a>
+</p>
 
-> **Warning:**
-The current distribution of ASLS Studio is in alpha status. Listed features are provided as-is, without any guarantee. Please report any issue over the project's repository. 
+## Overview
 
+ASLS Studio is currently in beta version and available for download through its GitHub repository. This guide will help you set up ASLS Studio on your machine.
 
-## Motivation
+> **Warning**: ASLS Studio is in early beta phase. Features are provided as-is, without guarantees. Please report any issues on the project's repository.
 
-Part of ASLS (Autonomous Stage Lighting Systems) development, it was originally created to offer ways to program ASLS DMX nodes on the fly through a simple web-browser. Following the end of the project, it was decided to release the project as an open-source, free to use platform for anyone to enjoy. 
+Full software documentation is available at [studio.asls.io](https://studio.asls.timekadel.com).
 
-## Features
+## System Requirements
 
-ASLS Studio comes with standard DMX lighting control software features such as Universe patching, Fixture grouping, Scene generation, Effect engines, Show Emulation and much more. The following manual aims to guide you through each individual feature.
-
-
-# Installation
-
-The alpha version of ASLS Studio is presently available to download through it's [repository](https://github.com/ASLS-org/studio.git). An executable version of the software should be released during beta state.
-This section will help you download and setup ASLS Studio on your machine.
+### Hardware
+- RAM: 4GB minimum (8GB or more recommended)
+- Graphics: Integrated graphics with WebGL 1.0 / WebGL 2.0 support (Dedicated GPU recommended)
 
-> **Warning:**
-The current distribution of ASLS Studio is in alpha status. Listed features are provided as-is, without any guarantee. Please report any issue over the project's repository. 
+### Software
+- Operating System: Any OS supporting the required software
+- Node.js: v16.15.1 or higher
+- Browser: Latest version of Chrome, Firefox, or Opera
 
-## Requirements
+## Installation Process
 
-> **Info:**
-As of today, there is no **"user-friendly"** installation script available to download. It is recommended to users that might not be familiar with [Git](https://git-scm.com/)/[GitHub](https://github.com/) and [Node.js](https://nodejs.org/en/) to read a bit about these tools before proceeding with the next steps.
+1. **Clone the Repository**
 
-In order for ASLS Studio to run on your machine, please make sure that you meet the following minimum system specifications:
+   Open a terminal and navigate to your desired installation directory. Then run:
 
-### Hardware
+   ```
+   git clone https://github.com/ASLS-org/studio
+   ```
 
-- 4GB of RAM (8GB or more recommended)
-- Integrated graphics with WebGL 1.0 / WebGL 2.0 support (A dedicated GPU is recommended)
+2. **Navigate to Project Directory**
 
-### Software
-- [Node.js](https://nodejs.org/en/) v16.15.1 or upper
-- Latest version of one of the following browsers: [Chrome](https://www.google.com/chrome/), [Firefox](https://www.mozilla.org/en-US/firefox/new/), [Opera](https://www.opera.com/download)
-
+   ```
+   cd studio
+   ```
 
-## Download and install
+3. **Install Dependencies**
 
-Browse to the path of your choice and run the following command from a terminal:
+   ```
+   npm install
+   ```
 
-```
-$ git clone https://github.com/ASLS-org/studio.git
-```
+## Running ASLS Studio
 
-Get to the project's root.
-```
-$ cd studio
-```
+### Local Development Server
 
-Install package dependencies.
-```
-$ npm install
-```
+To start ASLS Studio on a local development server:
 
-## Start Environment locally
+1. Run the following command:
 
-Serve ASLS Studio in the local server.
-```
-$ npm run serve
-```
+   ```
+   npm start
+   ```
 
-ASLS Studio will start a server at http://localhost:4515. Simply browse to the following URL using your favorite browser to be prompted with ASLS Studio's user interface.
+2. Open your browser and navigate to [http://localhost:5173](http://localhost:5173)
 
-## Build For Production
+### Production Build
 
-Build ASLS Studio from source.
+To create a production build:
 
-```
-$ npm run build
-```
+1. Run the build command:
 
-Built files will be located over the local `./dist` folder located at project root.
+   ```
+   npm run build
+   ```
 
-# Getting Started
+2. Locate the built files in the `./dist` folder at the project root.
 
-Please refer to [ASLS Studio's manual](https://studio.asls.timekadel.com) for an in-depth guide on how to use this tool. 
+## Troubleshooting
 
-> **Warning:**
-Please note that this is an early alpha version. Documentation is still in progress. It will be updated following the next releases.
+If you encounter any issues during installation or usage, please report them on the [ASLS Studio GitHub repository](https://github.com/ASLS-org/studio/issues).

docs/developer/ui/.storybook/main.js

@@ -1,4 +1,4 @@
-const path = require('path');
+import * as path from 'path'
 
 module.exports = {
   "addons": [

docs/developer/ui/.storybook/preview.js

@@ -5,7 +5,7 @@ import uikit from '@/views/components/uikit/'
 import {storiesOf} from '@storybook/vue';
 import { action } from '@storybook/addon-actions'
 import theme from './theme.asls.js'
-const { parse } = require('comment-parser/lib')
+import { parse } from 'comment-parser/lib'
 
 
 /**

docs/manual/.vitepress/config.js

@@ -2,16 +2,17 @@ export default {
   title: "ASLS Studio",
   description: "Open-source, web-based DMX lighting control software.",
   head:[
-    ['link', { rel: "icon", type: "image/png", sizes: "32x32", href: "/asls-logo.png"}],
+    ['link', { rel: "icon", type: "image/png", sizes: "32x32", href: "/studio_standalone_logo.png"}],
   ],
   themeConfig: {
     siteTitle: "ASLS Studio",
-    algolia: {
-      apiKey: '535c62495650c876ca7413debb4491ff',
-      indexName: 'ASLS',
-      appId: '1L7RJIJ77A'
+    search:{
+      provider: 'local',
     },
-    logo: '/asls-logo.png',
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/asls-org/studio' },
+    ],
+    logo: '/studio_standalone_logo.png',
     nav: [{
         text: 'User Manual',
         link: '/introduction/'
@@ -101,11 +102,11 @@ export default {
     },
     footer: {
       message: "ASLS Studio - Released under the GPLv3 License",
-      copyright: "Copyright (C) 2021-present Timé Kadel."
+      copyright: `Copyright (©) 2021-${new Date().getFullYear()} Timé Kadel.`
     },
     markdown: {
       // theme: 'material-palenight'
       toc: "every"
     }
   }
-}
+}