⌚ 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 7e1a5c3011 Remove .env to be replaced with per-env .env files in deployment 1 month ago
app Create database through makefile. 1 month ago
bin Boyscout: render the port on which the server is started. 7 months ago
config Create database through makefile. 1 month ago
data Import a lookup table with country names. 7 months ago
doc Add swagger doc and build HTML from it. 7 months ago
images Implement basic json serialisation for events with lat-lon pairs 1 month ago
lib Create database through makefile. 1 month ago
test Implement basic json serialisation for events with lat-lon pairs 1 month ago
vendor/imposm-0.6.0-alpha.4-linux-x86-64 Add latest imposm release. 9 months ago
.gitignore Remove .env to be replaced with per-env .env files in deployment 1 month ago
.rubocop.yml Add linter: rubocop 5 months ago
.semver Add semver. 5 months ago
Gemfile Implement basic json serialisation for events with lat-lon pairs 1 month ago
Gemfile.lock Implement basic json serialisation for events with lat-lon pairs 1 month ago
LICENSE Add LICENSE 8 months ago
Makefile Create database through makefile. 1 month ago
Procfile Add a Procfile to run the Web and Processors. 5 months ago
README.md Add initial README file 7 months ago
Rakefile Create database through makefile. 1 month ago
config.ru Implement basic json serialisation for events with lat-lon pairs 1 month ago
mapping.yml Fill a database lookup table with administrative boundaries. 7 months ago

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.