Getting Started

Two ways to install WorshipDeck: on your own server, which is the main way, or with the experimental Windows desktop installer. Then a first service you can prepare in about 10 minutes.

Written for WorshipDeck 0.1.1

On your own server (recommended)

Running WorshipDeck on a server or computer on your church network is the main way to use it. The operator console, the congregation screen, and the phone remote then open in a browser. You need Go 1.24 or later and Node.js 22.12 or later.

  1. Get the code

    Clone the repository, then run npm install in it.

  2. Set it up

    npm run setup creates .env with fresh secrets, creates the database with the SDAH hymnal and the KJV Bible and no layouts, and prints the admin password it generated. Running it again is safe: it never overwrites an existing .env or database.

  3. Start it

    npm run spa:build and then npm start serve everything from port 3000. Open that address in a browser and sign in as admin.

git clone https://github.com/wiradeltaid/worship-deck.git
cd worship-deck
npm install
npm run setup
npm run spa:build
npm start
Serve it behind HTTPS, also on the church network. Keep the secrets in .env unique to your installation and out of any repository, and back up the database and the uploads folder. The security page lists what to check.

To work on the code instead, npm run dev runs the Go API on port 3000 and the React development server on port 5173.

Windows desktop installer (experimental)

The desktop installer is experimental. Test it on the computer you will use before a service depends on it. It is not code-signed yet, so Windows SmartScreen may warn on first run.

Use the installer on a church media computer running Windows 10 or Windows 11 (64-bit).

  1. Download the installer

    Download WorshipDeck-0.1.1-x64-setup.exe from the GitHub releases page.

  2. Run the installer

    The installer is in English and Indonesian and follows the Windows display language, and it shows the MIT license text before installing. WorshipDeck installs into your user profile (%LocalAppData%\WorshipDeck), so you do not need administrator rights.

  3. Open WorshipDeck

    WorshipDeck opens as its own desktop window, with its own taskbar entry and icon, not a browser tab. On first launch, it creates its local SQLite database and loads the Seventh-day Adventist Hymnal (695 hymns) and the King James Version. Both are in English. It starts with no layouts: build them on the canvas or import slides from PowerPoint.

When you install a newer version over an existing one, your database (data.db), your layouts, and your uploaded announcement flyers are kept. On uninstall, WorshipDeck asks whether to also delete your locally stored data folder; the default answer is No, so your data is kept unless you choose to delete it.

Your first service

This walkthrough takes about 10 minutes. Do it before the service day to check your computer and projector setup.

  1. Create a service

    Open WorshipDeck and go to Services → New.

  2. Paste the order of service

    Paste the service text into the intake box. For example:

    SABBATH, OCTOBER 10, 2026
    Opening Song: SDAH #159 The Old Rugged Cross
    Verse Reading: John 3:16-17
    Sermon: Pr. Arthur Pendelton "Steady Light"
    Closing Song: SDAH #249 Praise Him! Praise Him!
  3. Generate the slides

    Click Parse. The parser looks up the hymn numbers in the local hymnal and builds the slide plan. Any line it does not recognize stays visible for you to review.

  4. Open the operator console

    Click Present. The operator console opens on your main screen.

  5. Open the congregation screen

    In the top bar of the operator console, click Open congregation screen. A 16:9 window opens. Drag it to the second screen or projector and press F11 to make it full screen without borders.

  6. Test the controls

    Press Space to move to the next slide, and press B to check that the screen blanks.

What you should see

When everything is set up:

  • The operator screen shows the dark console with the current slide, the next slide, and the order of service.
  • The congregation screen shows the slide text centered on a 16:9 canvas, with no window borders or buttons.
  • Pressing B turns the congregation screen black, and the operator console keeps your current slide highlighted.