polyphona / polyphona

🎵✍️ Le bloc-notes musical à la portée de tous

Polyphona

A familiar, portable music editor for your desktop.

Install

Client

Make sure you have Node ad npm installed, then run:

npm install

Server

Install dependencies using pip (preferably in a virtual environment):

pip install -r requirements.txt

Usage

Presentation of the backend server

The 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 sqlite3 module.

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.

Running the server

To run the server locally, run the following command from the project root directory:

gunicorn api:app

For more advanced use cases, please refer to the Gunicorn documentation or the process manager you are using.

Running the desktop app

To run the desktop app, run:

npm run dev

in the root directory.

Tests

The server comes with a test suite written with Pytest.

To run the test suite, run $ pytest from the project root directory.

Resources

To get started with Electron, read Writing your first Electron app.