Merge pull request #31 from catalystneuro/refactor/fix-build-issues

Refactor/fix build issues

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

.eslintignore

@@ -0,0 +1,4 @@
+node_modules
+dist
+out
+.gitignore

.eslintrc.cjs

@@ -1,18 +1,9 @@
 module.exports = {
-  root: true,
-  env: { browser: true, es2020: true },
   extends: [
     'eslint:recommended',
-    'plugin:@typescript-eslint/recommended',
-    'plugin:react-hooks/recommended',
-  ],
-  ignorePatterns: ['dist', '.eslintrc.cjs'],
-  parser: '@typescript-eslint/parser',
-  plugins: ['react-refresh'],
-  rules: {
-    'react-refresh/only-export-components': [
-      'warn',
-      { allowConstantExport: true },
-    ],
-  },
+    'plugin:react/recommended',
+    'plugin:react/jsx-runtime',
+    '@electron-toolkit/eslint-config-ts/recommended',
+    '@electron-toolkit/eslint-config-prettier'
+  ]
 }

.github/workflows/Build-and-deploy-linux.yml

@@ -2,13 +2,17 @@ name: Build and Deploy — Linux
 run-name: ${{ github.actor }} is building a Linux release
 
 on:
-  # push:
-  #   branches: ["latest"]
-
-  workflow_dispatch:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
 
 permissions:
-  contents: write 
+  actions: write
+  contents: write
+  packages: write
 
 jobs:
   deploy-on-linux:
@@ -23,22 +27,21 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
+          python-version: "3.11"
 
-      - uses: conda-incubator/setup-miniconda@v3
-        with:
-          activate-environment: vame-desktop
-          environment-file: environment.yml
-          auto-activate-base: false
+      - name: install python dependencies
+        run: | 
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
 
       - uses: actions/setup-node@v4
         with:
-          node-version: "18"
+          node-version: "20"
 
       - name: Install dependencies
         run: npm install
 
       - name: Build and deploy on Linux
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: npm run build -- --publish
+        run: npm run build:linux -- --publish=onTagOrDraft

.github/workflows/Build-and-deploy-mac.yml

@@ -3,13 +3,16 @@ run-name: ${{ github.actor }} is building a Mac release
 
 on:
   push:
-    branches: ["latest"]
-
-  workflow_dispatch:
-
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
 
 permissions:
-  contents: write 
+  actions: write
+  contents: write
+  packages: write
 
 jobs:
   deploy-on-mac:
@@ -24,13 +27,12 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
+          python-version: "3.11"
 
-      - uses: conda-incubator/setup-miniconda@v3
-        with:
-          activate-environment: vame-desktop
-          environment-file: environment.yml
-          auto-activate-base: false
+      - name: install python dependencies
+        run: | 
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
           
       - uses: actions/setup-node@v4
         with:
@@ -50,4 +52,4 @@ jobs:
           # APPLE_TEAM_ID: ${{ secrets.APPLE_TEAM_ID }}
           # APPLE_ID: ${{ secrets.APPLE_ID }}
           # APPLE_ID_PASSWORD: ${{ secrets.APPLE_PASSWORD }}
-        run: npm run build -- --publish
+        run: npm run build:mac -- --publish=onTagOrDraft

.github/workflows/Build-and-deploy-win.yml

@@ -3,12 +3,16 @@ run-name: ${{ github.actor }} is building a Windows release
 
 on:
   push:
-    branches: ["latest"]
-
-  workflow_dispatch:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
 
 permissions:
-  contents: write 
+  actions: write
+  contents: write
+  packages: write
 
 jobs:
   deploy-on-windows:
@@ -23,22 +27,21 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
+          python-version: "3.11"
 
-      - uses: conda-incubator/setup-miniconda@v3
-        with:
-          activate-environment: vame-desktop
-          environment-file: environment.yml
-          auto-activate-base: false
+      - name: install python dependencies
+        run: | 
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
 
       - uses: actions/setup-node@v4
         with:
-          node-version: "18"
+          node-version: "20"
 
       - name: Install dependencies
         run: npm install
 
       - name: Build and deploy on Windows
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: npm run build -- --publish
+        run: npm run build:win -- --publish=onTagOrDraft

.gitignore

@@ -1,18 +1,14 @@
-venv/*
-
 # Demo
 demo_output
 data/*.mp4
 
 # Python
+venv
 __pycache__
 
-# Commoners Output
-.commoners
-
 # Python Service Output
-build
-*.spec
+resources/python/build
+resources/python/main
 
 # Logs
 logs
@@ -25,6 +21,7 @@ lerna-debug.log*
 
 node_modules
 dist
+out
 dist-ssr
 *.local
 

.npmrc

@@ -0,0 +1,2 @@
+electron_mirror=https://npmmirror.com/mirrors/electron/
+electron_builder_binaries_mirror=https://npmmirror.com/mirrors/electron-builder-binaries/

.prettierignore

@@ -0,0 +1,6 @@
+out
+dist
+pnpm-lock.yaml
+LICENSE.md
+tsconfig.json
+tsconfig.*.json

.prettierrc.yaml

@@ -0,0 +1,4 @@
+singleQuote: true
+semi: false
+printWidth: 100
+trailingComma: none

.python-version

@@ -0,0 +1 @@
+3.11.9

README.md

@@ -1,16 +1,40 @@
 # VAME Desktop
 A desktop application for the Variational Animal Motion Encoding (VAME) project.
 
-> **Note:** VAME Desktop has been built on [commoners](http://github.com/neuralinterfaces/commoners) for distribution as a cross-platform desktop application. However, the project is still in development and is not yet ready for distribution. **You will need to follow the local installation instructions below to run the app.**
-
 ## Overview
 VAME Desktop has been designed to run each step of a VAME project **only once**. This is to ensure that the project is reproducible and that the data is not accidentally overwritten.
 
-
 ## Installation
 ### Python
-You will need to have [miniconda](https://docs.conda.io/en/latest/miniconda.html) installed on your machine.
+You will need to have [miniconda](https://docs.conda.io/en/latest/miniconda.html) installed on your machine OR [pyenv](https://github.com/pyenv/pyenv).
+
+#### with pyenv:
+
+```bash
+pyenv local
+```
+
+```bash
+python -m venv venv
+```
+
+Unix system (linux or macos):
+```bash
+source ./venv/bin/activate
+```
+
+Windows:
+```sh
+.\venv\Scripts\activate.bat
+```
+
+This will install all the necessary Python dependencies for the project.
+
+```bash
+python -m pip install -r requiremente.txt
+```
 
+#### with conda:
 Create the Conda environment for the project by running the following command:
 
 ```bash
@@ -24,7 +48,8 @@ conda activate vame-desktop
 ```
 
 ### Node.js
-You will need to have [Node.js](https://nodejs.org/en/) installed on your machine.
+You will need to have [Node.js 20](https://nodejs.org/en/) installed on your machine.
+You also can use [nvm](https://github.com/nvm-sh/nvm) or [n](https://github.com/tj/n) to select versions.
 
 Install Node modules by running the following command:
 ```bash
@@ -36,7 +61,26 @@ This only needs to be run once at project initialization and when the `package.j
 ## Running the App
 To run the app, you will need to run the following command:
 ```bash
-npm run start
+npm run dev
 ```
 
-This will start the Electron app.
+This will start the Electron app on developer mode.
+
+## Build:
+
+The build process will create a `.exe`, `.dmg` or `.deb` depend on OS. Run differents command on incompatible OS will result on error.
+
+MacOS
+```bash
+npm run build:mac
+```
+
+Windows
+```bash
+npm run build:win
+```
+
+Linux Debian
+```bash
+npm run build:linux
+```