Shard Detail

engine-rest-api v1.3.0

API service for interacting with PlaceOS.

Install & Use

Add the following code to your project's shard.yml under:

dependencies to use in production
- OR -
development_dependencies to use in development


engine-rest-api:
  github: PlaceOS/rest-api
  version: 1.3.0

Readme

Crystal ACAEngine REST API

Build Status

Testing

crystal spec to run tests

Compiling

crystal build ./src/engine-api.cr

Dependencies

  • Elasticsearch ~> v7.2
  • RethinkDB ~> v2.3.6
  • Etcd ~> v3.3.13
  • Redis ~> v5

Deploying

Once compiled you are left with a binary ./engine-api

  • for help ./engine-api --help
  • viewing routes ./engine-api --routes
  • run on a different port or host ./engine-api -b 0.0.0.0 -p 80