https://github.com/igneus/church-calendar-api

API providing Roman Catholic church calendar data for your apps
https://github.com/igneus/church-calendar-api

api calendar church hacktoberfest

Last synced: 3 days ago
JSON representation

API providing Roman Catholic church calendar data for your apps

• Host: GitHub
• URL: https://github.com/igneus/church-calendar-api
• Owner: igneus
• Created: 2015-06-08T21:32:59.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-04-01T07:22:15.000Z (9 months ago)
• Last Synced: 2024-11-23T13:14:45.196Z (29 days ago)
• Topics: api, calendar, church, hacktoberfest
• Language: Ruby
• Homepage: http://calapi.inadiutorium.cz
• Size: 166 KB
• Stars: 114
• Watchers: 15
• Forks: 58
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

• awesome-church-calendar - igneus/church-calendar-api
• awesome-catholic - church-calendar-api - API RESTful que proporciona datos de calendario de la iglesia católica romana para sus aplicaciones (API)

README

        
# Church Calendar API

[![Build Status](https://travis-ci.org/igneus/church-calendar-api.svg?branch=master)](https://travis-ci.org/igneus/church-calendar-api)

Browse Roman Catholic liturgical calendar through a web interface

or obtain it's data in JSON format through an API.

Powered by

[calendarium-romanum][caro] and

grape.

## Explore it on-line

Church Calendar API is a more or less RESTful read-only JSON API.

API documentation with URI examples and live links to API endpoints:

http://calapi.inadiutorium.cz/api-doc

## Running locally

1. install dependencies using Bundler

   `$ bundle install`

2. start application by `$ rackup`

## Running your own instance on Heroku

The application works as is, you only need to create a new application

in your Heroku dashboard and push the code.

Typical reasons for running your own instance include:

- availability/reliability requirements

  (the [reference instance][calapi] is self-hosted by the author

  and only maintained as free time permits;

  it may be terminated at any time)

- very high traffic expected

- custom calendar data that cannot be released as open-source

  (e.g. because it is copyrighted by the diocese)

- required control over data and algorithm updates

  (the reference instance is updated without prior notice)

## Running with Docker

This repository includes a `dockerfile` and a `docker-compose.yml`. You can run your own instance by running the following command from inside this folder:

`$ docker-compose up -d --build`

## Running specs

`$ rake test`

## Adding custom data

In order to add a new calendar:

1. put it's data file(s) in the `data` directory

2. create a new record in `config/calendars.yml`

## Client libraries

- Ruby: [calendarium-romanum-remote][caro_remote]

## License

GNU/LGPL 3 or later

[calapi]: http://calapi.inadiutorium.cz

[caro]: http://github.com/igneus/calendarium-romanum

[caro_data]: https://github.com/igneus/calendarium-romanum/tree/master/data

[caro_remote]: https://github.com/igneus/calendarium-romanum-remote