Skip to content

Commit

Permalink
chore(repo): update readme and about page
Browse files Browse the repository at this point in the history
remove contact info for RemixDev
  • Loading branch information
bambanah committed Sep 12, 2024
1 parent c6f0926 commit ee29267
Show file tree
Hide file tree
Showing 28 changed files with 52 additions and 899 deletions.
83 changes: 48 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,67 @@
# deemix-gui
# Deemix

An electron app that wraps deemix-webui and lets you use the deemix-js library
This is the monorepo for the revived Deemix project, originally created by the very talented [RemixDev](https://gitlab.com/RemixDev).

It contains the following packages:

- **deezer-sdk**: Wrapper for Deezer's [API](https://developers.deezer.com/api)
- **deemix**: The brains of the operation
- **webui**: [Vue.js](https://vuejs.org/) + [Express](https://expressjs.com/) web interface
- **gui**: Packaged [Electron](https://www.electronjs.org/) app

## Downloads

Downloads are available [here](https://www.reddit.com/r/deemix/comments/hmrhhs/download_links/)
A compiled electron app is available to download from the [releases page](https://github.com/bambanah/deemix/releases).

## Running from source
Deemix is also available as a [docker image](https://github.com/bambanah/deemix/pkgs/container/deemix).

You need to use nodejs 16.x, using `yarn` is recommended.
## Feature requests

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.
Before asking for a feature make sure there isn't already an [open issue](https://github.com/bambanah/deemix/issues).

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`
## Developing

Commands for easy setup:
This repo uses [pnpm](https://pnpm.io/) for package management and [Turborepo](https://turbo.build/repo/docs) for monorepo management.

```sh
# 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
```
### Dependencies

You can change the default port by setting the environment variable `PORT` to any other number before starting the app.
- Install Node.js 20.x
- Enable pnpm:
```bash
corepack enable
```

## Building the app
### Local Development

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.
1. Clone the repository
```bash
git clone https://github.com/bambanah/deemix.git
# - OR -
gh repo clone bambanah/deemix
```
2. Install dependencies
```bash
pnpm i
```
3. Start development server
```bash
pnpm dev
```
- This will start the development server on port 6595
- It will also watch for changes in dependencies and hot reload the app

## Feature requests
### Building the Docker Image

Before asking for a feature make sure it isn't an already open issue on the repo
A docker image can be built with the provided Dockerfile.

# License
```bash
docker build -t deemix .
```

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.
### Packaging the Electron GUI

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.
A distributable GUI app can be built with the following command:

You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
```bash
pnpm make
```
2 changes: 1 addition & 1 deletion deemix/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"lint": "eslint .",
"type-check": "tsc --noEmit"
},
"author": "RemixDev",
"author": "Bambanah",
"license": "GPL-3.0-or-later",
"dependencies": {
"@spotify/web-api-ts-sdk": "^1.2.0",
Expand Down
4 changes: 2 additions & 2 deletions deezer-sdk/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@
},
"repository": {
"type": "git",
"url": "https://gitlab.com/RemixDev/deezer-sdk"
"url": "https://github.com/bambanah/deemix"
},
"author": "RemixDev",
"author": "Bambanah",
"license": "GPL-3.0-or-later",
"dependencies": {
"got": "14.4.2",
Expand Down
107 changes: 0 additions & 107 deletions webui/COMPILE-UI.md

This file was deleted.

Loading

0 comments on commit ee29267

Please sign in to comment.