Skip to content
This repository was archived by the owner on Apr 28, 2022. It is now read-only.

README.md

Latest commit

聽

History

History
39 lines (27 loc) 路 1.61 KB

README.md

File metadata and controls

39 lines (27 loc) 路 1.61 KB
Raw

Serif

Web-based lyrics display software.

Background

This project is maintained by Hizkia Felix and Jonathan Filbert. Originally we started this project as we have been searching for an alternative and more flexible lyric displaying software to be used in our local church.

We have tried some free and open source church software, but they are just either too fragile, bloated, or did not fit our needs.

We 馃憦 Just 馃憦 Want 馃憦 To 馃憦 Display 馃憦 Lyrics.

And so we decided that desktop software is not really our target product here, since there are a lot of people that have done so. So we picked an alternative approach, which is to developed a web app instead. Not just an ordinary web app, but a blazing-fast web app whose sole job is to display lyrics in a single browser page with a black background (As the approach in our church is to layer this lyric afterwards to our Resolume visual layer).

Stack

  • React 鈿涳笍
  • Redux 鈾伙笍
  • Styled Components 馃拝馃徎
  • Cross tab functionalities using Local Storage 馃實

What's included?

  • / Homepage
  • /controller Control Page
    • You can control which songs and which lyrics should be displayed by the display page
    • You can also add new songs in this page
  • /display Display Page
    • You can see the displayed lyric here
    • It is recommended to run this tab on a seperate window as this will be the page that is displayed on your projector / external display device.

How to run this?

  • git clone
  • npm install
  • npm start
  • Go to http://localhost:3000 in your browser
  • ???
  • Profit! 馃挵