Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Matchmore Javascript SDK

MatchmoreSDK is a contextualized publish/subscribe model which can be used to model any geolocated or proximity based mobile application.

Usage

In a browser

Include dist/web/matchmore.js into your page and start by creating a Manager() instance. The Manager will allow you to create Users, Devices, Publications, Subscriptions, ...

In your project

  1. Use npm to include MatchMore
npm install @matchmore/matchmore --save

or

yarn add @matchmore/matchmore
  1. Then import the library
import { Manager } from "@matchmore/matchmore";
  1. And then start your application with minimum config
this.manager = new Manager(
  "<Your api key>"
)

Testing

To run the tests:

IMPORTANT Please edit test/config.ts to add a valid API key before to use the tests

npm test

Compilation

Install dependencies:

npm install

To compile the project:

npm run build

To create a Standalone (using Browserify):

npm run browserify

Create a (greatly) minified version

npm run minify

Testing

Coding