Nepomuk

This project offers a library/bindings for running a transit service on GTFS feeds, implemented in modern C++.

This project requires valid GTFS feeds to run. Use any of the many available GTFS validators to check if your GTFS dataset qualifies.

Building

Dependencies of this project are pulled in via Mason. Building it is as simple as checking out the project and running cmake/make.

The main project can be build via cmake. For example:

mkdir build
mkdir build/release

cd build/release
cmake -DCMAKE_BUILD_TYPE=Release ../..
make

IPC Infrastructure / Running a service

There are multiple ways you can run Nepomuk. Nepomuk comes with its own IPC service (ipc-provider) found within the apps directory. This ipc-provider can listen to any port (tcp/ipc/...) supported by zeroMQ (http://zeromq.org/). It expects messages in the form of PBF (https://github.com/mapbox/nepomuk/tree/master/src/ipc/proto). It will process the message and return an appropriate PBF response. To run a server, you can simply start up an ipc-provider in the background, specifying a port to listen on and a dataset to use. After, you can perform your own Req/Rep pattern against this IPC service.

For convenience, we also offer traditional node bindings that hide the IPC communication. You still have to start up the backhround process, but afterwards you can use a normal parameterised scheme to access Nepomuk. Simply perform tile/route requests and the bindings take care of the IPC part to the ipc-provider.

Tests

Tests are using ctest. Run ctest (or ctest --verbose) from within your build directory.

cd build/release
ctest

Nodebindings

Nodebindings can be build via node-cmake. To build the bindings, simply specify -DNODEBINDINGS=On when configuring the project.

mkdir build
mkdir build/release

cd build/release
cmake -DCMAKE_BUILD_TYPE=Release -DNODEBINDINGS=On ../..
make

To do so, you need to have node installed in version 4 or later.

nvm install 4
nvm use 4

Tests

To test the node bindings, you can run npm test from within node/nepomuk/. Make sure to run npm install beforehand.

cd node/nepomuk/
npm install
npm test

Frontend/Example Server

The frontend and the example server are provided as a pure example. We highly discourage the usage of both in any production example.

GTFS sources / validation

There are many GTFS feeds available on the internet. While we will always do our best to verify input to prevent security issues, we strongly advie anyone to make use of validation tools (E.g. https://developers.google.com/transit/gtfs/guides/tools), or any of the many available open source checkers. The validation mechanisms implemented here are no replacement for additional checks of the surrounding API. The example server and it's checks are in no way a recommendation on how to ensure a safe API.