Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kmille/freetar
freetar - an alternative frontend for ultimate-guitar.com
https://github.com/kmille/freetar
Last synced: 4 months ago
JSON representation
freetar - an alternative frontend for ultimate-guitar.com
- Host: GitHub
- URL: https://github.com/kmille/freetar
- Owner: kmille
- License: gpl-3.0
- Created: 2023-04-01T10:40:30.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-12T17:24:28.000Z (11 months ago)
- Last Synced: 2024-05-15T10:54:38.079Z (9 months ago)
- Language: HTML
- Size: 149 KB
- Stars: 598
- Watchers: 6
- Forks: 20
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-privacy-front-ends - freetar - An alternative front-end for ultimate-guitar.com with a simple design. No ads or pop-ups. `Python/GPL-3.0`. (List / Ultimate Guitar)
README
# freetar - an open source alternative front-end to ultimate-guitar.com
This is like [Invidious](https://invidious.io/) but only for [Ultimate Guitar](https://www.ultimate-guitar.com/).
**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
- https://freetar.de
- https://freetar.habedieeh.re
- https://tabs.adast.dk
## 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](https://python-poetry.org/). 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](https://addons.mozilla.org/en-US/firefox/addon/invidious-redirection/)