@myasha/client.devkit v0.2.4

Overview

Bitbucket status

The collection api is responsible for handling all data used/rendered on the application.

For Developers

This is a Nodejs package that wraps all microservice methods to a client class and connects using RESTful XHR calls.

Requirements

Install the list of softwares listed below:

• Git (Only if installing from source)
• Nodejs

Install from source

Clone the repository,

git clone git@bitbucket.org:ashaworldwide/client.devkit.git

Direct to cloned folder,

cd client.devkit

Install dependencies

npm install

Optional (Test project)

Run the test scripts to validate that you can connect to the database.

npm test

Install via NPM

npm install @myasha/client.devkit

Usage

import SDK from '@myasha/client.devkit'
export const sdk = new SDK();

// Authenticate
sdk.authentication.login(user_credentials)
.then(token => console.log(token))
.catch(err => console.log(err))

// Get all Restaurants
sdk.restaurants.findAll()
.then(resp => console.log(resp))
.catch(err => console.log(err))

API

To view the complete documentation of code. Install solution from source and run the blow commands:

cd client.devkit

npm run document

## Assuming you have an alias of chrome installed.
chrome docs/typedoc/index.html

## Alternatively navigate to /docs/typedoc and open index.html in your favourite browser.