Skip to content

kalo-realtime/backend-api

Repository files navigation

Dispatcher REST API

Responsibilities

  1. Authenticate drivers/passengers/users
  2. Get a diff of current drivers
  3. Get all registered drivers
  4. Ping a specific driver/passenger
  5. Ping drivers within a defined perimeter

Installation

Key Dependencies

Build Steps

1. Clone the library.

  git clone [email protected]:kalo-realtime/backend-api.git

2. Install dependencies.

  cd backend-api/
  npm install

3. Configure redis, mongo and postgres configs at config/default.json.

4. Make sure redis, mongo and postgres services are running and no other service is running on defined ports for zmq sockets.

5. Start the server

  npm start

TODO

Abstraction layers

  • Pubsub layer (kafka, zmq .etc)
  • Transport layer (web socket, mqtt)
  • Message type (text/binary)
  • Message format (json, protocol buffers .etc)
  • Message filtering
  • Authentication
  • Location storage (mongo, redis, postgis. etc)
  • Dispatch strategy

  • Test suite

License

Kalo is released under the MIT license

About

Dispatcher and API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages