⌚ OpenOpeningstijden main server application
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Bèr Kessels dafdab90a5 Merge branch 'release/0.3.0' 1 year ago
app Include sundays in open_this_week attribute. 1 year ago
bin Ensure we continue after a duplicate 2 years ago
config Introduce pagination to indexes. 1 year ago
data Import a lookup table with country names. 2 years ago
doc Add swagger doc and build HTML from it. 3 years ago
images Implement basic json serialisation for events with lat-lon pairs 2 years ago
lib Ensure we always have a "city". Set it from geocoder if not provided 1 year ago
public/images Turn status into :open, :closed or :unknown triplet. 1 year ago
test Include sundays in open_this_week attribute. 1 year ago
vendor Use local patched gems instead of vanilla 1 year ago
.env.test Ensure we can set per-app-env ENV vars 2 years ago
.gitignore Package all gems to ensure heroku uses our patched versions 1 year ago
.rubocop.yml Add linter: rubocop 2 years ago
.ruby-version Update Ruby and Rubygems. 2 years ago
.semver Add semver. 2 years ago
Gemfile Use local patched gems instead of vanilla 1 year ago
Gemfile.lock Use local patched gems instead of vanilla 1 year ago
LICENSE Add LICENSE 3 years ago
Makefile Allow make initiator to define the pattern of tests to be ran. 1 year ago
Procfile Add a Procfile to run the Web and Processors. 2 years ago
README.md Add initial README file 3 years ago
Rakefile Change loading logic of entire suite in Rakefile 2 years ago
config.ru Setup bootstrap basics 2 years ago
mapping.yml Fill a database lookup table with administrative boundaries. 2 years ago



RESTful JSON API for opening hours

Getting Started

TODO: Finish Make Install TODO: Provide alternative in docker


A Linux machine that supports apt, preferably a recent Ubuntu LTS.

make install should ensure all dependencies are installed.

For machines that do not support Make, consider getting another OS, if anything, as a virtual machine.

For machines that do not have apt, we are open to help on making the Makefile more portable. Pull requests, suggestions and help is welcome. The ideal situation would be where all common POSIX compliant systems, will be able to run the Makefile and install dependencies.


Install all dependencies with

make install

Running the tests

Running the tests with

make test

Integration tests

Integration tests, or end to end tests, are tests that run expectations on the full application. It sets up, seeds and connects to a database and then makes requests through the REST HTTP interface.

These are slow, and will, nor cannot, cover all edge-cases, paths and exceptions. They cover the happy path, common situations and important features.

Currently ran inside the entire test-suite. If the suite grows too large, we will extract these and make them runnable separately.

Unit tests

The unit tests isolate a module and test that in isolation. Unfortunately, JavaScript, nor node, nor its ecosystem of packages are very clean and test-oriented. Many features, packages or libraries will inject their behaviour in the global namespace, making it very hard, sometimes impossible to mock or stub.

There are quite some tests, but not near as much as I would like.


Deploying depends on your environment. Anywhere where NodeJS is supported will probably run this software.

TODO: describe what config to change in order to deploy to your servers.

make deploy

Built With




We use SemVer for versioning. For the versions available, see the release-tags on this repository


  • Bèr Kessels


This project is licensed under the MIT License - see the LICENSE.md file for details


TODO: describe YoHours, openstreetmap, imposm, opening_hours etc.