TDvorak/swingmusic-extended
1
0
Fork 0
mirror of https://github.com/Dvorinka/swingmusic-extended.git synced 2026-06-03 20:13:02 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
mungai-njoroge
2023-09-18 18:27:29 +03:00
parent b849cd9306
commit 9ac744b5ee
3 changed files with 9 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2 -40
View File
@@ -42,8 +42,6 @@ Usage: swingmusic [options]
| `--scan-interval` | `-psi` | Set the periodic scan interval in seconds. Default is 300 seconds (5 minutes) |
| `--build` | | Build the application (in development) |
To stream your music across your local network, use the `--host` flag to run the app in all ports. Like this:
```sh
@@ -105,48 +103,12 @@ inside the container to be accessible from the host's IP on port `8080` outside
| `-v /music` | Recommended directory to store your music collection. You can bind other folder if you wish. |
| `-v /config` | Configuration files. |
### Development
This project is broken down into 2. The client and the server. The client comprises of the user interface code. This
part is written in Typescript, Vue 3 and SCSS. To setup the client, checkout
the [swing client repo ](https://github.com/geoffrey45/swing-client) on GitHub.
The second part of this project is the server. This is the main part of the app that runs on your machine, interacts
with audio files and send data to the client. It's written in Python 3.
The following instructions will guide you on how to setup the **server**.
---
The project uses [Python poetry](https://python-poetry.org) as the virtual environment manager. Follow the instructions
in [their docs](https://python-poetry.org/docs/) to install it in your machine.
> It is assumed that you have `Python 3.10` or newer installed in your machine. This project uses type hinting features
> so older version of Python will not work. If you don't have Python installed in your machine, get it from
> the [python website](https://www.python.org/downloads/).
Clone this repo locally in your machine. Then install the project dependencies and start the app.
```sh
git clone https://github.com/geoffrey45/swingmusic.git
cd swingmusic
# install dependencies using poetry
poetry install
# start the app
poetry run python manage.py
```
### Contributing
If you want to contribute to this project, feel free to open an issue or a pull request on Github. Your contributions
are highly valued and appreciated. Feature suggestions, bug reports and code contribution are welcome.
See [contributing guidelines](.github/contributing.md).
### License
This software is provided to you with terms stated in the MIT License. Read the full text in the `LICENSE` file located
at the root of this repository.
This software is provided to you with terms stated in the MIT License. Read the full text in the `LICENSE` file located at the root of this repository.
**[MIT License](https://opensource.org/licenses/MIT) | Copyright (c) 2023 Mungai Njoroge**