Jazztunes is an app to help jazz musicians manage their repertoire. To use it, go to jazztunes.org.
This readme focuses on technical aspects of the app of interest to developers; for a user manual, see here.
Jazztunes uses Django 5.0 on the back end and htmx on the front end with Bootstrap for styling. The database is PostgreSQL. It uses DataTables for column sorting. Tests are written in pytest. It runs on Python 3.11 or later.
If you want to run jazztunes locally, take the following steps:
- Clone this repository.
- Navigate to the 'jazztunes' directory.
- Create a virtual environment
python -m venv venv''' (Windows/Linux) orpython3 -m venv venv``` (Mac). - Activate the virtual environment
.\venv\Scripts\activate(Windows) orsource venv/bin/activate - Install the necessary packages:
pip install -r requirements.txt - Create a .env file in the root directory with the variables (I've supplied a file, env-template, that shows what you need and has some default values)
- If you want to use the Public tune feature, you'll need to create a superuser:
python manage.py createsuperuser, then set that user's ID to ADMIN_USER_ID in .env (it will be 1 if it's the first user created, otherwise 2, etc.). Then tunes you create as that user will also show up on the Public page. Creating a superuser is also a good idea because it gives you access to the Django admin interface. - Run the program:
python manage.py runserver - Ctrl-click on
http://127.0.0.1:8000— This will open jazztunes in your default browser. - You can close the program by closing your browser and pressing Ctrl-C in the terminal running it.
Jazztunes is free software, released under version 3.0 of the GPL. Everyone has the right to use, modify, and distribute jazztunes subject to the stipulations of that license.