Lyric Frequency

Lyric Frequency is a web-application that lets you search for an album and displays the occurrence of each word in the album.

https://lyric-frequency-56927045982.europe-west9.run.app

Please be patient, this is running on a Google Cloud VM with 512MB of RAM

Setup for local dev

Create a .env file at the root of the project and complete it:

touch .env
nano .env

DJANGO_SECRET_KEY=""
DJANGO_ENV=dev
DJANGO_ALLOWED_HOSTS=""
DATABASE_URL=""

Setup the project:

virtualenv --python="/usr/bin/python3" env 
source env/bin/activate
cd main/
pip install -r requirements.txt
python manage.py tailwind install
python manage.py makemigrations django
python manage.py migrate

Then, in a first terminal, start tailwind to update any CSS change:

python manage.py tailwind start

In a second terminal, start the server:

python manage.py runserver

Setup for Docker

Create a .env file at the root of the project and complete it:

touch .env
nano .env

DJANGO_SECRET_KEY=""
DJANGO_ENV=prod
DJANGO_ALLOWED_HOSTS=""

Then, start your first container:

docker build -t lyric-frequency . && docker run --name lyric-frequency -itd -p 80:8000 lyric-frequency

Go to http://localhost

Versions

• Python 3.10.12
• Node 20.12.2
• Scrapy 2.11.2
• Plotly 5.23.0

Structure

main/
  main/
    django/     -- backend 
    scraper/    -- crawl data from Genius
    web/        -- frontend 
.dockerignore
.gitignore
Dockerfile
LICENSE
README.md

References

• Genius
• Django
• Django Secret Key Generator
• Django Tailwind
• Tailwind CSS
• Scrapy
• scrapy-djangoitem
• HTMX - high power tools for HTML
• Plotly Open Source Graphing Library for Python
• Supabase
• WhiteNoise
• Stack Overflow - Scrapy 'ReactorNotRestartable' error
• Docker
• Render
• Docker on Render
• Dockerizing Django with Postgres, Gunicorn, and Nginx