Kiwano Webapp (Workshop 4)

The Webapp codenamed - Kiwano is a system component, part of the Creator IoT Workshop 4 - Temperature Logger.
The application developed in Node.js is hosted in Heroku, a Platform as a Service (Paas). The application uses a MongoDB database, hosted in the cloud - mLab, therefore providing data cloud storage.
Kiwano is a middle tier Webapp, which consumes the Device Server REST API and it's resources, fetching for connected devices (AwLWM2M clients) and it's temperature values. Finally the Webapp provides a RESTAPI to consume the DataBase, in Project 4 it's used an Android Mobile App, but another REST client could also be used.

Webapp Architecture

Jump Start

There are two ways to use the Webapp:

1. Cloud Deployment
2. Locally

The application, uses a jwt access token (x-access-token). You can encode your secret using - JWT Builder.

Note: Change the name of template_config.js to config.js.

Cloud Deployment

This guide exaplains the process of cloud deploying the Webapp in Heroku and mLab, using their free tiers. However the performance can be improved using a payed service, or if you prefer different hosting services: AWS, Google Cloud, etc.

1. Project Setup

1. Clone the project from git repository
2. Rename template_config.js to config.js
3. Remove config.js from .gitignore

2. Developer Console - Create Account

1. Create a Developer Console account
2. Generate a set of API Keys
3. Insert the API Keys into the config.js file, located on your projects root folder

3. mLab - Create the DB (Manual Setup)

1. Sign up for an mlab free account
2. Create a new database (select Single Node, Sandbox for the free tier)
3. Add a user
4. Save the database URI (connection string) visible on the dashboard: mongodb://<dbuser>:<dbpassword>@<dbuser>.mlab.com:<port>/<db_name> (it will be used in step 4.6).

4. Heroku - Push The Webapp Source Code

1. Create an Heroku account
2. Install Heroku Command Line Interface (CLI)
3. Enter your Heroku credentials: $ heroku login
4. Create the application on Heroku: $ heroku create
5. Complete the connection string with your account details. Save the connection string as mongo db configuration: $ heroku config:set MONGOLAB_URI=your_db_uri
6. Modify config.js and update HOST with your application url (will be used to handle subscriptions)
7. On the console add to stage and commit the changes: $ git add . $ git commit -m "First commit"
8. Deploy the application on Heroku: $ git push heroku master

Start The Web App (Locally)

1. Get the project, by ZIP download or git clone
2. Install Node.js LTS
3. Install the Webapp's dependencies. On projects root directory, execute: $ npm install
4. Insert the API Keys into the config.js file, located in your projects root folder.
5. Install MongoDB
6. Use a proxy (e.g. Ngrok) to expose the local application on an https server
7. Start the application: $ npm start

REST Endpoints

Description

• client - Data source (sensor), in this example - Temperature Sensor
• ID - Unique hex identifier for each client
• Delta - Interval between temperature samples
• Data - Temperature (in this example)

Generate RESTAPI Documentation

You can generate documentation using APIDOCS. Install and execute:

$ npm install apidoc -g
$ apidoc -i ./api_v1

Help

If you have any problems installing or utilising this project, please look into our Creator Forum.

Otherwise, If you have come across a nasty bug or would like to suggest new features to be added then please go ahead and open an issue or a pull request against this repo.

License

Please see the license file for a detailed explanation.

Contributing

Any Bug fixes and/or feature enhancements are welcome. Please see the contributing file for a detailed explanation.