Skip to content

README.md

Latest commit

 

History

History
56 lines (31 loc) · 1.98 KB

README.md

File metadata and controls

56 lines (31 loc) · 1.98 KB

Door Controller Service

This service operates as a controller for a door opening actuator. Instead of a real actuator it simulates the actuator.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Installing

  1. Clone this repository
  2. Open CLI
  3. Change into the cloned repository via CLI
  4. Execute npm install on CLI

Congratulations! 🎉 - You are ready to start the program with the command node app.js. Alternatively you can run swagger project start, if you want an automatically restart of the server by changing files in this project. The command swagger project edit lets you edit the OpenAPI definition for this RESTful driven service. The service is reachable via HTTPS and HTTP at the port 10010 on the local machine (localhost) with /api/v1 as base path.

Running the tests

At the moment, there are no automatic tests available. You can test the API via curl.

Deployment

TODO

Built With

Contributing

Feel free to contribute.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Tobias Straub

See also the list of contributors who participated in this project.

License

GNU Affero General Public License v3.0

Acknowledgments

No acknowledgments to show at the moment