Skip to content

Latest commit

 

History

History
63 lines (47 loc) · 1.96 KB

README.md

File metadata and controls

63 lines (47 loc) · 1.96 KB
Raw

freetar - an open source alternative front-end to ultimate-guitar.com

This is like Invidious but only for Ultimate Guitar.

UPDATE 22.10.2024: As ultimate-guitar.com started to block (some? my? server?) ip addresses it's now possible to send requests to UG over Tor (socks5 proxy listening on localhost:9050). This feature can be enabled when environment variable FREETAR_ENABLE_TOR=1 is set. Supported since Freetar version 0.10.0.

Instances

Features

  • no ads, popups, AI, blockchain. Just a simple design
  • search for tabs and view them
  • save your favorite chords as favs (everything is stored in session storage (not send to the server), no account needed)
  • dark mode
  • auto scroll
  • useful for printing chords
  • show chords

How to use it

After successfull installation, there is an executable called freetar in the PATH. Execute it without parameters and it listens on 0.0.0.0:22000.

PyPi
Package: https://pypi.org/project/freetar/

pip install freetar

Docker
Image: https://hub.docker.com/r/kmille2/freetar
Port: 22000

sudo docker pull kmille2/freetar
sudo docker run -p 127.0.0.1:22000:22000 kmille2/freetar

Dev environment

You need poetry. Then:

poetry install
vim freetar/*.py
poetry run python freetar/backend.py
Visit localhost:22000 in browser

# static files: freetar/static/*
# html templates: freetar/templates/*
poetry run freetar

Future work

  • show chords
  • improve UX on mobile devices
  • on smartphones: prevent lock screen
  • share chords (qr code)? (done by #12 with export/import functionality)
  • save favs encrypted server side?
  • Browser Extension like Invidious Redirection (done)