Find a file
2022-12-14 14:23:04 +01:00
build Added build scripts 2021-05-29 13:58:10 +02:00
scripts Added update checker 2022-01-13 01:33:29 +01:00
server Updated dependencies 2022-12-14 13:46:22 +01:00
webui@2d19cccebd Updated dependencies 2022-12-14 13:46:22 +01:00
.gitattributes workflow: added .gitattributes 2021-05-13 21:39:09 +02:00
.gitignore Updated deemix lib to 3.3.5 2021-07-28 13:22:35 +02:00
.gitmodules Initial commit 2021-03-26 13:29:10 +01:00
.yarnrc chore: moved .yarnrc to the root of the project 2021-06-02 16:31:56 +02:00
index.js Fixed server passing the wrong argument to the webui when using electron 2022-07-30 10:11:54 +02:00
LICENSE.txt Added README.md and LICENSE.txt 2021-05-29 18:32:29 +02:00
package.json Added macOS arm64 build 2022-12-14 14:23:04 +01:00
preload.js Removed unused preload channels 2022-05-28 15:22:40 +02:00
README.md Small update to README.md 2022-11-22 20:59:34 +00:00
yarn.lock Updated electron 2022-12-14 14:17:16 +01:00

deemix-gui

An electron app that wraps deemix-webui and lets you use the deemix-js library

Downloads

Downloads are available here

Running from source

You need to use nodejs 16.x, using yarn is recommended.

If you're using git to get this repo you should use git submodule update --init --recursive as well. If you're just downloading the archive.zip, make sure you download and extract deemix-webui into the webui folder.

Install the dependencies using yarn install-all for production. Install the dependencies using yarn install-all-dev for development. Then you should be able to run the app with yarn start. If you want to further develop deemix-gui and propose a PR, use yarn dev

Commands for easy setup:

# Production
git clone https://gitlab.com/RemixDev/deemix-gui.git . && git submodule update --init --recursive && yarn install-all
# Development
git clone https://gitlab.com/RemixDev/deemix-gui.git . && git submodule update --init --recursive && yarn install-all-dev

You can change the default port by setting the environment variable PORT to any other number before starting the app.

Building the app

To build the app you need to have git installed and the repo cloned with git. Make sure you've installed the dependencies for all packages (the root folder, server and webui). Then from the root folder run yarn dist to make a distributable package for your current OS or yarn dist-server to make an executable for only the server.

Feature requests

Before asking for a feature make sure it isn't an already open issue on the repo

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.