Skip to content

samliu21/lyrics-chords

Repository files navigation

Lyrics & Chords Songsheet Creator

Live Website

https://lyrics-chords.herokuapp.com

Sample.Session.mov

Sample Screen

API Documentation

API Documentation

Usage

This website was created for my needs as a learning guitarist, but I thought I'd share it with the GitHub community! It offers a broad range of songsheet capabilities that include lyric scraping, adding chords and strumming patterns, auto scrolling, and more!

You can also look at public songsheets that other guitarists have publicized!

Technologies Used: React, Django, PostgreSQL, NGINX, SQLite, Redux, DRF, Python, JavaScript, HTML, CSS

Local Installation

General

  1. Run git clone https://github.com/samliu21/lyrics-chords in bash.
  2. Navigate to lyrics-chords/

Backend Installation

  1. Install pipenv with pip install pipenv.
  2. Call pipenv install, followed by pipenv shell to activate the virtual environment and install required dependencies.
  3. Finally, call python manage.py runserver to run the server.

Frontend Installation

  1. Call npm ci.
  2. Run the server with npm start.

API Key

  1. Create an API token here. This API key is used for the lyric scraping feature of the website
  2. Make a .env file and add API_KEY=<your_api_key into the file.