A familiar, portable music editor for your desktop.
Make sure you have Node ad npm installed, then run:
npm installInstall dependencies using pip (preferably in a virtual environment):
pip install -r requirements.txtThe server stores songs and user data. The desktop app uses its REST API to display and manipulate data.
It consists in:
- A web application server, written in Python using Falcon (a REST API framework) and running on Gunicorn (or a similar process manager);
- A database module, also written in Python and backed by SQLite and the
sqlite3module.
The database itself is stored in a file named polyphona_db.db. If no file is found a new one will be created upon the launch of the server.
To run the server locally, run the following command from the project root directory:
gunicorn api:appFor more advanced use cases, please refer to the Gunicorn documentation or the process manager you are using.
To run the desktop app, run:
npm run devin the root directory.
The server comes with a test suite written with Pytest.
To run the test suite, run $ pytest from the project root directory.
To get started with Electron, read Writing your first Electron app.