Skip to content
buzcarterPublic

About

UkeGeeks Scriptasaurus turns plain-text or ChordPro ukulele songs into song sheets with chord diagrams. Drop-in JS library plus a self-hosted songbook (Node.js or PHP). Docs at ukegeeks.org. Test drive it now:

Resources

Stars

110 stars

Watchers

23 watching

Forks

Repository files navigation

UkeGeeks Songbook

Your ukulele club's songbook, on your own website. Drop your songsheets into a folder and the Songbook turns them into a song list with quick search and clean, printable song pages with chord diagrams. Its built-in Song-a-matic editor lets players transpose, switch tunings and resize a song before printing it.

Try it: live demo

A song in the Songbook: chord diagrams on the left, lyrics with chords above them, and the Song-a-matic editor open on the right

Quick start

You need Node.js 18 or newer. No other installs, no database.

npm start

Then open http://127.0.0.1:8080/ in your browser.

Prefer PHP? If your web host runs PHP and Apache, the same songbook runs there too: see Running the songbook with PHP.

Adding your songs

Songs live in the cpm/ folder, one plain-text file per song, named something.cpm.txt. They're written in ChordPro: chords go in square brackets right where they change, like [C]Mary had a [G7]little lamb. The sample songs in cpm/ show the markup, and the User's Guide and ChordPro Markup Reference cover the rest.

You can also add and edit songs in the browser once you've set up an account.

The song list, with quick search

Settings

Copy ugs.config.example.json to ugs.config.json to set your songbook's title, require a login, add editor accounts, or share it on your network. See Configuration, which also shows how to change the editor's defaults (font size, tuning, theme).

Building

The pages load prebuilt JavaScript and CSS, so you don't need to build to run the songbook. If you change anything under src/:

npm install
npm run build

See Building, CI and the demo site for what the build does, the static demo and the GitHub Actions workflow.

Tests

npm test

More

Part of the UkeGeeks family

The UkeGeeks mascot, a dinosaur playing the ukulele

Not sure which one you need? See which UkeGeeks tool is right for you.

Authors

Contributors: David Calam (djc-503), louis-coding, AceLan Kao (acelan) and hutzelknecht.

License

Licensed under the GNU General Public License. Use it, change it, fork it, but please keep the author attribution.

ukegeeks.com is no longer affiliated with this project; the official site is ukegeeks.org.

About

UkeGeeks Scriptasaurus turns plain-text or ChordPro ukulele songs into song sheets with chord diagrams. Drop-in JS library plus a self-hosted songbook (Node.js or PHP). Docs at ukegeeks.org. Test drive it now:

Resources

Stars

110 stars

Watchers

23 watching

Forks

Releases

Packages

Used by

Contributors

Languages