⌚ 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 e114839d8b Merge branch 'feature/bragi' into develop 2 miesięcy temu
app Add search endpoint to render a search result. 2 miesięcy temu
bin Let Sinnk handle either a place or a region based on payload 3 miesięcy temu
config Don't load dotenv or unused/broken gems. 4 miesięcy temu
doc Add swagger doc and build HTML from it. 1 rok temu
images Implement basic json serialisation for events with lat-lon pairs 11 miesięcy temu
lib Add search endpoint to render a search result. 2 miesięcy temu
public/images Add autocomplete with Horsey using a custom backend service 2 miesięcy temu
test Add search endpoint to render a search result. 2 miesięcy temu
vendor Add a search query projector to handle requests through bragi 2 miesięcy temu
.gitignore Don't git-track any .env file 4 miesięcy temu
.rubocop.yml Add linter: rubocop 1 rok temu
.ruby-version Update Ruby and Rubygems. 11 miesięcy temu
.semver Add semver. 1 rok temu
Gemfile Add a search query projector to handle requests through bragi 2 miesięcy temu
Gemfile.lock Add a search query projector to handle requests through bragi 2 miesięcy temu
LICENSE Add LICENSE 1 rok temu
Makefile Remove sourcing of env in makefile because this breaks dotenv 4 miesięcy temu
Procfile Add a Procfile to run the Web and Processors. 1 rok temu
README.md Add initial README file 1 rok temu
Rakefile Add region commmand and projection 3 miesięcy temu
config.ru Setup bootstrap basics 7 miesięcy temu
mapping.yml Fill a database lookup table with administrative boundaries. 1 rok temu

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.