deemix-py/README.md

73 lines
2.9 KiB
Markdown
Raw Normal View History

2020-04-11 14:44:52 +00:00
# WARNING
The webUI is not finished, some functions may not work.
2020-04-11 14:44:52 +00:00
# deemix
## What is deemix?
deemix is a deezer downloader built from the ashes of Deezloader Remix. The base library (or core) can be used as a stand alone CLI app or implemented in an UI using the API.
2020-04-28 16:44:01 +00:00
## How can I use this?
Currently there are no available builds as it's still in development.<br>
But you can try to run it yourself!<br>
## Running instructions
2020-05-05 10:55:06 +00:00
### Standard way
NOTE: Python 3 is required for this app. Make sure you tick the option to add Python to PATH when installing.<br>
NOTE: If `python3` is "not a recognized command" try using `python` instead.<br>
2020-04-11 14:44:52 +00:00
<br>
After installing Python open a terminal/command prompt and install the dependencies using `python3 -m pip install -r requirements.txt --user`<br>
Run `python3 -m deemix --help` to see how to use the app in CLI mode.<br>
2020-05-12 15:48:08 +00:00
Run `python3 server.py` to start the server and then connect to `127.0.0.1:9666`. The GUI should show up.<br>
Enjoy!<br>
2020-02-17 16:02:52 +00:00
2020-05-05 10:55:06 +00:00
### Easy Windows way
Download `install.bat` file to your PC and place it in the folder where you want Deemix to live<br>
Start the `install.bat` as administrator<br>
Wait for it to finish, then run the `start.bat`<br>
2020-05-12 23:33:04 +00:00
### Easy Mac way
2020-05-12 23:34:07 +00:00
Download `install_mac.sh` file to your Mac and place it in the folder where you want Deemix to live<br>
Open a terminal and type `sh` and a space, then drag `install_mac.sh` into your terminal window and press `enter`<br>
The web-gui will launch when the installer is finished, and launching it in the future can be done with the generated file `startdeemix.command`<br>
To update to the latest build, run the generated file `updatedeemix.command`<br>
2020-05-12 23:33:04 +00:00
## What's left to do?
Library:
- Write the API Documentation
2020-04-16 10:10:47 +00:00
2020-05-05 13:42:02 +00:00
in the WebUI:
- Install sass dependency
2020-05-05 13:42:02 +00:00
- Make the UI look coherent
- Search tab
2020-05-09 15:32:59 +00:00
- Better style for placeholer before search
2020-05-05 13:42:02 +00:00
- Better loading feadback fot the user (maybe with a loading circle)
- Charts tab
- Move world chart on top
2020-05-05 13:42:02 +00:00
- On country selection, move scrolled window to top
- Link Analyzer
2020-05-09 11:47:42 +00:00
- Better style for placeholer before analyzing
2020-05-05 13:42:02 +00:00
- Settings tab
- Stylize and separate the options
- Maybe tabbing the section for easy navigation
- About tab
- Write stuff about the app
- ?
2020-05-13 14:46:01 +00:00
Application:
- Add an auto updater
2020-05-13 14:48:21 +00:00
- Add installer for windows
- AppImage builds
2020-05-13 14:46:01 +00:00
2020-04-15 09:12:25 +00:00
# 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/>.