⌚ 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 273251069c Merge branch 'feature/styling-minor' into develop 1 anno fa
app Style footer 1 anno fa
bin Let Sinnk handle either a place or a region based on payload 1 anno fa
config Fix linting issues with capistrano 1 anno fa
doc Add swagger doc and build HTML from it. 2 anni fa
images Implement basic json serialisation for events with lat-lon pairs 2 anni fa
lib Only render breadcrumb if we have a breadcrumb 1 anno fa
public/images Improve the layout of the homepage: 1 anno fa
test Fix test after releasing working change 1 anno fa
vendor Configure capistrano to run on our app server 1 anno fa
.gitignore Ignore log dir as generated by capistrano 1 anno fa
.rubocop.yml Add linter: rubocop 2 anni fa
.ruby-version Update Ruby and Rubygems. 2 anni fa
.semver Add semver. 2 anni fa
Capfile Fix linting issues with capistrano 1 anno fa
Gemfile Use puma in production 1 anno fa
Gemfile.lock Configure capistrano to run on our app server 1 anno fa
LICENSE Add LICENSE 2 anni fa
Makefile Add "deploy" target to makefile 1 anno fa
Procfile Add a Procfile to run the Web and Processors. 2 anni fa
README.md Add initial README file 2 anni fa
Rakefile Add region commmand and projection 1 anno fa
config.ru Setup bootstrap basics 1 anno fa
mapping.yml Fill a database lookup table with administrative boundaries. 2 anni fa

README.md

Hours

RESTful JSON API for opening hours

Getting Started

TODO: Finish Make Install TODO: Provide alternative in docker

Prerequisites

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.

Installing

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.

Deployment

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

Contributing

TODO: introduce CONTRIBUTING.md

Versioning

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

Authors

  • Bèr Kessels

License

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

Acknowledgments

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