ito - how-to

Before starting

License agreement

ito is released under the MIT License.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Backend services

To run ito on your enviromnemt, developer account for one of the following backend services is required:

Also, you MUST follow Terms of Service for any backend service which you use:

Install ito in your environment

Case 1: Clone ito from GitHub

git clone https://github.com/tomoyukilabs/ito.git

If you wish to run ito on Node.js, please install dependent libraries:

npm install --save

Case 2: Import ito from npm

npm install --save ito-js

Setup before using ito

Firebase

Create your Firebase project at Firebase Console.
Configure Authentication -> Sign-in method (if needed).
- Select Sign-in providers as you need.
- For Facebook, App ID, App secret and OAuth redirect URI must be configured as well.
- Add your domain to OAuth redirect domains.
- Note: GitHub and Twitter are not supported yet.
Copy and paste etc/firebase-rules.json into Database -> Rules.
Confirm the snippet from Authentication -> Web setup, and note down the values of apiKey, authDomain and databaseURL. These values are used in ito.init().

Kii Cloud

Note: Node.js is required to initialize a Kii Cloud application.

Create your app at Kii Developer Portal.
- Choose HTML5 as your application's platform.
- Choose a server location appropriate for you.
- For detailed information, please refer to http://docs.kii.com/en/guides/cloudsdk/javascript/quickstart/create-app/.
Configure social network settings (if needed).
- For detailed information, please refer to http://docs.kii.com/en/guides/cloudsdk/javascript/managing-users/social-network-integration/.
Confirm your APP ID, APP KEY, CLIENT ID and CLIENT SECRET.
- These values are required to initialize your Kii Cloud application (see 4.) and deploy Server Code (see 5.).
- The values of APP ID and APP KEY are used in ito.init().
- For detailed information, please refer to http://docs.kii.com/en/guides/cloudsdk/javascript/quickstart/create-app/#checking-appid-and-appkey.

Run the script etc/kii-init.js by Node.js on your shell (Terminal, etc.), as follows:

$ node etc/kii-init.js \
  --site [us|eu|cn3|sg|jp] \
  --app-id <your_app_id> \
  --app-key <your_app_key> \
  --client-id <your_client_id> \
  --client-secret <your_client_secret>

Deploy etc/kii-server-code.js as Server Code with etc/kii-server-hook.json as Server hook Configuration File, by using Command Line Tools. For example:

$ node kii-cli/bin/kii-servercode.js deploy-file \
  --file etc/kii-server-code.js \
  --site [us|eu|cn3|sg|jp] \
  --app-id <your_app_id> \
  --app-key <your_app_key> \
  --client-id <your_client_id> \
  --client-secret <your_client_secret> \
  --hook-config etc/kii-server-hook.json

Load ito in your web app

Browsers + Firebase

<script src="src/ito.js"></script>
<script src="src/ito-firebase.js"></script>

Browsers + Kii Cloud

<script src="src/ito.js"></script>
<script src="src/ito-kii.js"></script>

Node.js

let ito = require('ito-js');

For further information about API, please refer to API.md on GitHub Repository.