Skip to content

Latest commit

 

History

History
75 lines (50 loc) · 2.41 KB

README.md

File metadata and controls

75 lines (50 loc) · 2.41 KB
Raw

introtorhythm.com

Intro To Rhythm is a freeform mix series and live-streaming audio station that began in 2017. All episodes and content are owned by their creators and made exclusively for Intro To Rhythm.

Additionally, ITR is dedicated to open-source projects, and the collective idea sharing that fuels creative expression. If you're interested in developing your own live-streaming station or podcasting platform, you're invited to refer to ITR's source code (Licence MIT).

Send questions and comments to introtorhythm@gmail.com

Dependencies

  • Node v12 or greater
  • Python v3.8 or greater
  • Python's virtualenv package v20 or greater

Project Versions

  • Django 3.1.4
  • Python 3.8.10
  • Vue 2.6.14

Installation

# download repo
git clone [this repo] introtorhythm.com

# if virtualenv is already installed, set up virtual environment
python -m venv introtorhythm.com/

# else, install virtualenv, then run the previous step
pip install virtualenv

# once the virtual environment is set, connect to the virtualenv and install the project dependencies

# activate the virtual environment
source ./venv/bin/activate # mac/ linux
source ./venv/Scripts/activate # windows

# once activated, install project packages
pip install -r requirements.txt

# install the front-end app
cd app
yarn [or npm] install
yarn serve # or yarn build, if in prod

Note - the introtorhythm.com/settings.py file requires certain config values to be set in a file called env.ini in the project root. If you're running this for the first time, you can copy the values from the example.env.ini file also found in the project root. Ensure that the env.ini file does not go to source control. Similarly, ensure that that any real env keys do not get committed to the example.env.ini file.

Running the site locally

# navigate into the project root
# cd introtorhythm.com

# activate the virtual environment
source ./venv/bin/activate # mac/ linux
source ./venv/Scripts/activate # windows

# migrate the database tables
python manage.py migrate

# start the back-end server
python manage.py runserver

# build front-end application
cd app
yarn serve

More info

For more information regarding configuration and cron jobs, check the wiki!