npm

Don't miss out on this year's npm Pride t-shirt designs!Order your favorites here »

kyper-matter

0.2.10 • Public • Published

Matter

npm version npm downloads build status dependencies status codeclimate coverage license

What are the minimal tools I need to make an app matter?

Matter is a Javascript library that provides common web application functionality such as user authentication and local/session/token storage. This library is built to communicate with a Tessellate Server such as Tessellate for application data, but custom server setups are on the roadmap.

Matter is Isomorphic, which means it will work well in both Browser and NodeJS environments. ES6 functionality is also available through importing and/or extending Matter (more details below).

Quick Start

Using Matter requires having created an application on Build, Tessellate or on your own Tessellate server.

Browser

  1. Include the Matter library using one of the following:

#### CDN

To use the CDN, add the following script tag to your index.html:

```html
<!-- Matter Library Bundle -->
<script src="http://cdn.kyper.io/js/matter/latest/matter.js"></script>
```

#### Bower Run bower install --save kyper-matter

  1. Start using Matter by providing the name of the app you created on Build or Tessellate:
//New Matter object with the application name 'exampleApp'
var matter = new Matter('exampleApp');
  1. Start using Matter:
//Login to account with username "test" and password "test"
matter.login({username:"test", password:"test"}).then(function(user){
    console.log('User logged into exampleApp:', user);
});

ES6

  1. Run npm install --save kyper-matter
  2. Import Matter library
import Matter from 'kyper-matter';
  1. Create a new matter application object:
//New matter object with the application name 'exampleApp'
let matter = new Matter('exampleApp');
//Login to account with username "test" and password "test"
matter.login({username:"test", password:"test"}).then((user) => {
  console.log('User logged into exampleApp:', user);
}, (err) => {
  console.error('Error logging in:', err);
});
  1. Use Matter methods

NodeJS

  1. Run npm install --save kyper-matter
  2. Import Matter library
var Matter = require('kyper-matter');
  1. Create a new matter application object:
//New matter object with the application name 'exampleApp'
var matter = new Matter('exampleApp');
//Login to account with username "test" and password "test"
matter.login({username:"test", password:"test"}).then(function(user) {
  console.log('User logged into exampleApp:', user);
}, function(err) {
  console.error('Error logging in:', err);
});

Options

When creating a new matter object, you can provide an options object as the second argument:

//New matter object with the application name 'exampleApp'
var optionsObj = {
  localServer: false,
  logLevel: 'trace'
}
var matter = new Matter('exampleApp', optionsObj);

Availble options:

  • logLevel - Level of logging (error, warn, info, debug, or trace)
  • localServer - Boolean of whether or not to use local tessellate server

Docs

API Documentation

Examples

More Information

For more details please visit the Matter Wiki.

Test

Tests are located in test folder and can be run via gulp test or gulp coverage commands.

index.html has been added as a bare bones test page similar to browser example (`/examples/browser/index.html).

TODO

  • Run tests git pre-push
  • More local storage capabilities
  • Version release gulp task

install

npm i kyper-matter

Downloadsweekly downloads

93

version

0.2.10

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
Report a vulnerability