A Spotify-based web application that allows users to place annotations, or 'pins', into songs at specified timestamps. These pins are able to be customized with a message and a duration.
- Install MariaDB (v10.6.4) to create a local database source in your IDE. If you're using PyCharm, see the instructions here.
Step 1: Clone the repository from terminal git clone https://github.com/lunarmint/spotipyn.git
. If you use GitHub Desktop, clone the repository with it will achieve similar result.
Step 2: Create a copy of .env.example
file, rename it to .env
and fill in all the required variables as specified in the file.
Step 3: Create a copy of config.default.yml
file, rename it to config.yml
and fill in all the required variables as specified in the file.
Step 4: From the terminal, run pip install -r requirements.txt
.
Step 5: The entry point to interpret the application will be spotipyn.py
.
Any contributions are more than welcomed. Please follow these steps to get your work merged in:
- Clone the repository.
- Create a new branch
git checkout -b branch_name
(or create one with GitHub Desktop from the branch view) for your work. - Make changes in the code.
- Open a Pull Request with a comprehensive list of changes.
This project relies predominantly on: