|Bèr Kessels 45c21d119b Add linter: rubocop||3 years ago|
|bin||2 years ago|
|config||2 years ago|
|data||2 years ago|
|doc||2 years ago|
|lib||2 years ago|
|models||2 years ago|
|serializers||2 years ago|
|services||2 years ago|
|test||2 years ago|
|utils||2 years ago|
|vendor/imposm-0.6.0-alpha.4-linux-x86-64||3 years ago|
|.gitignore||2 years ago|
|.rubocop.yml||2 years ago|
|.semver||2 years ago|
|Gemfile||2 years ago|
|Gemfile.lock||2 years ago|
|LICENSE||2 years ago|
|Makefile||2 years ago|
|README.md||2 years ago|
|app.js||2 years ago|
|mapping.yml||2 years ago|
|package.json||2 years ago|
|yarn.lock||2 years ago|
RESTful JSON API for opening hours
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
Running the tests with
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.
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.
TODO: introduce CONTRIBUTING.md
This project is licensed under the MIT License - see the LICENSE.md file for details
TODO: describe YoHours, openstreetmap, imposm, opening_hours etc.