/ChordsPortal

Organize your chords links with ChordsPortal

Primary LanguageJavaScriptBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

guitar logo ChordsPortal

ChordsPortal web page

Build your chords library with ChordsPortal.

It gives you a quick access to the chords you like the best, allows you to create categories, add new chords, and counts how many times you visit each link.

Setup

ChordsPortal is a Python/Flask project with some static web content. It uses pdm as a package management tool.

Install and run local instance

Running locally makes your data persistent.

$ cd chords_portal
$ pdm install
$ make

Run in a container

Running in a container makes your environment ephemeral, but it ensures the service is containerized and is easy to start.

Makefile calls podman, but feel free to replace it with docker.

$ make build
$ make run

This will build an image and run it in a container. It will expose the service on port 5000.

Access the service

Once you've run the service, visit http://localhost:5000/.

Data

ChordsPortal uses TinyDB, a JSON-based datastore which writes data/chords.json.

Inspect it with your favorite json viewer, for example:

$ jq . data/chords.json

Licence

See LICENCE.

Guitar icon by Icons8.

Icons: https://github.com/twbs/icons MIT licence.