Voice Melody application

Backend and entry point for vocal-accompaniment separation application

Usage

You need docker-compose and build frontend app in order to run this app

# build and run all dependencies
docker-compose up -d

# configure admin account with default credentials
./setup_admin.sh

Development

If you want to run this app locally without docker-compose, you need to either run postgresql with docker image or switch to sqlite by changing settings in the configuration file.

# start django server
python manage.py runserver

Description

Frontend application communicates with the backend through REST API. Authentication is made using JWT technology. Endopints used in the app:

get all songs for authenticated user:

GET /api/song/

add new song:

POST /api/song/
Parameter Type Description
song File Required. original music track

user registration:

POST /api/user/create/
Parameter Type
username string
email string
password string

user login:

POST /api/token/obtain/
Parameter Type
username string
password string

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT