/herrnhuter-daily

REST-API for Daily Herrnhuter Verses

Primary LanguageCSSGNU General Public License v3.0GPL-3.0

herrnhuter-daily

Go Report Card

This Project serves daily bible verses provided by the Herrnhuter BrĂĽdergemeinde via a REST API.

Installation

The software is written in go. To build it a go environment is needed. Install Go...

    git clone https://github.com/Kaitsh/herrnhuter-daily && cd herrnhuter-daily
    go build -o server

To run the server first build the source, then use the command:

    ./server

The server serves the API on :3333/api:

Ex.:

    curl http://localhost:3333/api/today

Routes

The currently available routes are:

  • General Information and Documentation: /
  • Verse of the Day: /v
  • All Verses of a Specific Year: /v/yyyy
  • All Verses of a Specific Month: /v/yyyy/mm
  • Verse of a Specific Date: /v/yyyy/mm/dd

Config

Currently there is no config available. To change settings please change them directly in code. The port is a global variable in the main.go file. Routes can be adjusted in the routes.go file.