@odecloud/odecloud

Official Site of @odecloud/odecloud

Summary ✨

Package contain helper functions currently utilized by a varieties of apps developed @odecloud.

Requirements

The package currently depend on these versions of Node and NPM.

$ node --version
v0.10.24

$ npm --version
1.3.21

Installation

Make you are currently in a Node project that contains a valid package.json file. Run the following below to download the package.

npm install @odecloud/odecloud

Usage Example

The example below assumes that your current project is using the latest ES6.

import OdeCloud from '@odecloud/odecloud';

// Instantiate the service
const odecloud = new OdeCloud({
  endpoint: "http://localhost:3000",
});

// Login to OdeCloud
// If you don't have an active OdeCloud's user account,
// then you can create one for free here: https://odecloud.app/signup
await odecloud.authenticate({
  email: "",    // your email
  password: "", // your password
});

const articles = await odecloud.articles.get({
  title: "Karl, San Francisco fog",
}); // return a list of articles matching the title

Local Testing/Development

You can download the package locally to your machine using:

$ git clone https://gitlab.com/odetech/odecloud.git @odecloud/odecloud

Commands

• npm test - Run tests with linting and coverage results.
• npm type-check - TypeScript checking
• type-check:watch - TypeScript checking and watching
• npm run build - Babel will transpile ES6 and TypeScript => ES5 and minify the code.

License

MIT © OdeCloud, Inc