README.md

greptime-js-sdk

The best third party JS|TS library scaffold.

Characteristics

• Coded in ES6+ or TypeScript, easily compile and generate production code
• Supports multi environment, including default browsers, Node, AMD, CMD, Webpack, Rollup, Fis and so on.
• Integrated jsmini

Note: When export and export default are not used at the same time, there is the option to turn on legacy mode. Under legacy mode, the module system can be compatible with IE6-8. For more information on legacy mode, please see rollup supplemental file.

Compatibility

Unit tests guarantee support on the following environment:

IE	CH	FF	SF	OP	IOS	Android	Node
6+	29+	55+	9+	50+	9+	4+	4+

Note: Compiling code depend on ES5, so you need import es5-shim to compatible with IE6-8, here is a demo

Directory

├── demo - Using demo
├── dist - Compiler output code
├── doc - Project documents
├── src - Source code directory
├── test - Unit tests
├── CHANGELOG.md - Change log
└── TODO.md - Planned features

Usage Instructions

Using npm, download and install the code.

$ npm install --save greptime

For node environment：

var base = require('greptime')

For webpack or similar environment：

import base from 'greptime'

For requirejs environment:

requirejs(['node_modules/greptime/dist/index.aio.js'], function (base) {
  // do something...
})

For browser environment:

<script src="node_modules/greptime/dist/index.aio.js"></script>

Documents

API

Contribution Guide

For the first time to run, you need to install dependencies firstly.

$ npm install

To build the project:

$ npm run build

To run unit tests:

$ npm test

Note: The browser environment needs to be tested manually under test/browser

Modify the version number in package.json, modify the version number in README.md, modify the CHANGELOG.md, and then release the new version.

$ npm run release

Publish the new version to NPM.

$ npm publish

Contributors

contributors

Change Log

CHANGELOG.md

TODO

TODO.md