deemix-gui/README.md

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

## Downloads
Downloads are available [here](https://www.reddit.com/r/deemix/comments/hmrhhs/download_links/)

## 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`.  
Then you should be able to run the app with `yarn start`.

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

## Building the app
Make sure you've installed the dependencies for all packages (the root folder, `server` and `webui`).  
Then from the root folder run `yarn prebuild` to build the server and the webui and then `yarn dist` to make a distributable package for your current OS.

## 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/>.
Added README.md and LICENSE.txt 2021-05-29 16:32:29 +00:00			`# deemix-gui`
			`An electron app that wraps deemix-webui and lets you use the deemix-js library`

			`## Downloads`
			`Downloads are available [here](https://www.reddit.com/r/deemix/comments/hmrhhs/download_links/)`

			`## 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`.
			Then you should be able to run the app with `yarn start`.

Updated README.md 2021-05-29 16:35:40 +00:00			You can change the default port by setting the environment variable `PORT` to any other number before starting the app.
Added README.md and LICENSE.txt 2021-05-29 16:32:29 +00:00
			`## Building the app`
			Make sure you've installed the dependencies for all packages (the root folder, `server` and `webui`).
			Then from the root folder run `yarn prebuild` to build the server and the webui and then `yarn dist` to make a distributable package for your current OS.

			`## 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/>.`