tcsenpai/swingmusic
1
0
Fork 0
mirror of https://github.com/tcsenpai/swingmusic.git synced 2025-06-06 03:05:35 +00:00
Code Issues 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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
.github/contributing.md vendored
View File

@ -1,6 +1,6 @@
# Swing Music Contributing Guide
Hi! We're really excited that you are interested in contributing to Swing Music. This project uses the Python, Flask, Sqlite, Poetry, and Vue.
Hi! We're really excited that you are interested in contributing to Swing Music. This project uses Python, [Flask](https://flask.palletsprojects.com/en/2.3.x/), Sqlite, [Poetry](https://python-poetry.org/), and [Vue](https://vuejs.org/).
If you are interested in making a code contribution take a moment to read through the following guidelines:
@ -25,7 +25,7 @@ This project is broken down into 2 parts. The server (this repo) and the client
To contribute to the server development, you need to install [Poetry package manager](https://python-poetry.org/docs).
Fork this repo, git clone and install all the dependencies:
Fork this repo, git clone and install the dependencies:
```sh
git clone https://github.com/swing-opensource/swingmusic.git
@ -45,8 +45,6 @@ Run the server. You can use a different port if you have another Swing Music ins
poetry run python manage.py --port 1980
```
If you are also
After that, checkout into a new branch and make your changes.
```sh
@ -57,7 +55,7 @@ Finally, commit your changes and open a pull request.
## Contributing to the client
You need to have [yarn](https://yarnpkg.com/) installed in your machine. See the [install guide](https://yarnpkg.com/getting-started/install).
You need to have [yarn](https://yarnpkg.com/) installed in your machine. See their [install guide](https://yarnpkg.com/getting-started/install).
Fork the repo, git clone and install the dependencies:
@ -91,4 +89,4 @@ If you need help, you can email me at: geoffreymungai45@gmail.com
Our Code of Conduct means that you are responsible for treating everyone on the project with respect and courtesy regardless of their identity. If you are the victim of any inappropriate behavior or comments as described in our Code of Conduct, we are here for you and will do the best to ensure that the abuser is reprimanded appropriately, per our code.
See yah!
See you around?

4
.gitignore vendored
View File

@ -25,4 +25,6 @@ client
.gitignore
logs.txt
*.spec
*.spec
TODO.md

42
README.md
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**