Skip to content

lelylan/physicals

Repository files navigation

Physical Proxy

Forward API requests to the physical world.

When a request is made from the cloud (through API) the physical URL (used to decouple the cloud from any physical device or protocol) is called by the physical proxy to forward the request to the physical world. An example of physical URL is the MQTT node.

Requirements

Lelylan Nodes is tested against Node 0.8.8.

Installation

$ git clone git@github.com:lelylan/physicals.git && cd physicals
$ npm install && npm install -g foreman coffee-script
$ nf start

Install with docker

Badges

Docker image: lelylanlab/physicals

Use docker hub image

$ docker run -d -it --name physicals lelylanlab/physicals

Generate local image

$ docker build --tag=physicals .
$ docker run -d -it --name physicals physicals

When installing the service in production set lelylan environment variables.

Resources

Contributing

Fork the repo on github and send a pull requests with topic branches. Do not forget to provide specs to your contribution.

Running specs

$ npm install
$ npm test

Coding guidelines

Follow Felix guidelines.

Feedback

Use the issue tracker for bugs or stack overflow for questions. Mail or Tweet us for any idea that can improve the project.

Links

Authors

Andrea Reginato

Contributors

Special thanks to all contributors for submitting patches.

Changelog

See CHANGELOG

License

Lelylan is licensed under the Apache License, Version 2.0.

About

Forward API requests to the physical world

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages