stateless-client-javascript

Brent Sanders
brent@brentsanders.io

• Documentation

Javascript client for Stateless

Install

1. Install Node.js
2. Install stateless-client-javascript via npm

npm install --save stateless-client-javascript

For the latest developer version, see Developer Install.

Usage

An example usage of stateless-client-javascript:

var statelessclientjavascript = require('stateless-client-javascript');

See Documentation for more details.

Contributions

1. Reports for issues and suggestions can be made using the issue submission interface.
2. Code contributions are submitted via pull requests

See CONTRIBUTING.md for more details.

Developer Notes

Developer Install

Install the latest developer version with npm from github:

npm install git+https://github.com/formulatedautomation/stateless-client-javascript

Install from git cloned source:

1. Ensure git is installed
2. Clone into current path
3. Install via npm

git clone https://github.com/formulatedautomation/stateless-client-javascript
cd stateless-client-javascript
npm install

Tests

1. Clone into current path git clone https://github.com/formulatedautomation/stateless-client-javascript
2. Enter into folder cd stateless-client-javascript
3. Ensure devDependencies are installed and available
4. Run tests
5. Results are saved to tests/log with each file corresponding to a version tested

npm install
npm test

Documentation

Use documentationjs to generate html documentation in the docs folder:

npm run docs

See JSDoc style for formatting syntax.

Upload to Github

1. Ensure git is installed
2. Inside the stateless-client-javascript folder, add all files and commit changes
3. Push to github

git add .
git commit -a -m "Generic update"
git push

Upload to npm

1. Update the version in package.json
2. Run tests and check for OK status
3. Generate documentation
4. Login to npm
5. Publish to npm

npm test
npm run docs
npm login
npm publish

Implementation

The module stateless-client-javascript uses the following npm packages for its implementation:

npm	Purpose
component	description
component	description
component	description
component	description

component   <-- detail
    |
component   <-- detail
    |
component   <-- detail
    |
component   <-- detail