tkoaly / laulum.me

E-songbook for sitsit

laulum.me

This is an electronic version of songbook for sitsit. All the songs in this repo are mostly as they are in TKO-äly ry official songbook. The site itself is hosted in https://laulum.me

Want to add a song? Make a pull request!

Song lyrics are stored in the songs/ directory.
If you want to add a song, create a new file in the directory with the song lyrics in it.

You'll also need to add a header, containing at least a title for the song:

---
title: Song title
---

Song lyrics...

You can also specify the melody and/or writers:

---
title: Gurulassa
melody: Anssi Kela - Puistossa
writers: Ada
---

Gurulassa ilta viilenee.
Topi lämpimikseen koodailee...

Books (WIP)

Books can be added as JSON files in the books folder. See books/tekis-2017.json for reference.

Books can be linked using their filename, e.g. tekis-2017.json matches https://laulum.me/book/tekis-2017.

Format

{
  "title": "Title of the book",
  // Can be left out. Currently not displayed.
  "organisation": "Organisation ry",
  // Credits can be left out.
  // Keys are used as headers in credits list.
  "credits": {
    "Book master": ["Matti Meikäläinen"],
    "Lyric collectors": ["Eeva Esimerkki", "Sumu Satunnainen"]
  },
  // Any amount of songs.
  // Songs are displayed in the order listed in this array.
  "songs": [
    {
      // Arbitrary string. Can be anything.
      "number": "32",
      // Automatically links to laulum.me song if title matches.
      "title": "Song name",
      // Can be left out. Overrides everything and shows just this content alongside number and title.
      "content": "Custom content",
      // Can be left out. Manually specifies laulum.me song slug to link to.
      "slug": "song-slug"
    }
  ]
}

Favicon

The favicon was created by Lassi Koistinen.

laulum.me's Issues

unkarin viini pakkanen

unkarin viini should have "pakkanen ei"

Käyttäjän pitäisi pystyä piirtämään

Jani L, [12.02.17 20:30]
Meil on muuten hieno elektroninen laulukirja nykyään
xxx, [12.02.17 20:40]
miten elektroniseen laulukirjaan voi piirtää kirkkoveneitä?
Jani L, [12.02.17 20:40]
hmm hyvä huomio
Jani L, [12.02.17 20:40]
pitää tehdä tästä issue

mpa > spa

ssr etc. buzz buzz buzz

"add to home screen"/"install" button

should not disturb the normal operation

will be more useful to make users install locally after #50 is implemented

add tg share button to song view

as a user i want to easily share what song i am requesting in a tg chat

might be even possible to add whole lyrics to the comment so that other don't need to go to laulum.me necessarily

https://core.telegram.org/widgets/share

läsy generator view

implement a läsy generator view that allows choosing of multiple songs to export all at once

• allow user to mass export songs (txt? copy-paste from a field? copy to clipboard?)
• allow numbering of songs
  • automatic by order of picking
  • manual sorting possible
• ready-made groups (toggles certain songs, e.g. "nyt songs", "parodies", "english", "must haves")
  • allow creation of custom groups (cookies?)

add koodaillaan credits

can be found in wiki.tko-aly.fi/Koodaillaan or something like that

add song numbers corresponding to song book

add song numbers from the 2015 physical song book so searching is easier

• displayed before song name
• songs can be searched using numbers
• search prioritizes song numbers when typing just numbers
• song numbers can be toggled off (see futureproofign idea below)

futureproofing: add generic "songbook-number" list attribute so multiple years can be switched between in ui, e.g. none, 2015 and 2022/2023, and it will update the song numbers in the ui for the current session

make song attributes more generic

switch from hardcoded line numbers (first for title, second for melody...) to e.g. markdown files with frontmatter

example:

Assarit
PMMP - Joutsenet
Mikko Halmela

Voit sanoa mitä haluat,
se ei tunnu se ei opeta
Mene vaan, mene vaan

-->

---
title: Assarit
melody: PMMP - Joutsenet
writer: Mikko Halmela
---
Voit sanoa mitä haluat,
se ei tunnu se ei opeta
Mene vaan, mene vaan

add dark mode toggle

currently the dark mode css respects OS preferences

we might want a seperate button to allow an override?

add documentation for song file format

Add documentation to README.md regarding song file format

Section titles in books

Books could have an option for section titles.

At this time non-existent songs can be used as section titles in book (see https://laulum.me/book/vappusitsit-2024).

cache all songs on initial load

download all songs' data to cache to allow offline viewing from first page load.

add font size slider

for when you need to read the lyrics near the end of the sits

make pwa work offline

use service workers to display songs even when no internet connection

https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Offline_Service_workers

Shortcuts to books

There could be shortcuts to books (e.g. https://laulum.me/book/tekis-2017) on the front page for example.

use media query for hover support for better mobile styles

currently applying :hover to every link causes them to blink when scrolling on mobile
we should check for hover support using media queries to avoid this problem

updating local offline cache is buggy

we should be cache-first but update all songs asap, it doesn't take that much data.
currently going directly to song page that's not in initial pwa caching results in 404 until force reload

Song search in a book

There could be a search field in a book for songs in the book, just like there is a search field for songs in whole laulum.me on the front page.

Song tags

Song tags for finding a certain type of a song, e.g. a short song or a song about Klusteri. One song can have 0-n tags. Tags are listed e.g. on the front page. Clicking a tag gives a list of songs including the tag.

add error boundary

non-cached offline songs cause typeerror and there might be more cases where errors are thrown