PureCloud Kiosk is a service that allows PureCloud users to create and manage check-in events.
- NodeJS (with NPM)
- MongoDB (3.2.1 or greater)
- Redis
- Elasticsearch (2.2.0)
- Clone this repo.
- Install the Node dependencies with
npm install. - Edit the fields in
config.json(if needed) to configure Mongo, Redis, Elastic, and Amazon AWS. Then start MongoDB and Redis. - Start the server with
npm startornode server.js. The server will be launched onto port8080.
Documentation was made with the help of Swagger. A live version of based off of the development branch can be accessed here.
Use npm run start-dev during development, it will watch files and relaunch the server whenever a new server is loaded.
For any new packages that need to be installed, be sure to save it into the package.json (for Node Modules) and bower.json (for Bower Components).
Just install using the --save argument when installing. Ex. npm install --save express or bower install --save bootstrap
Tests are written using Mocha. As development progresses, add tests to the test directory. To execute all of the tests, run npm test. Be sure to modify the test_mongo_uri (if needed) before testing.