Code Monkey home page Code Monkey logo

jmap-client's Introduction

JMAP-CLIENT

Join the chat at https://gitter.im/linagora/jmap-client Build Status Coverage Status

This repository provides a JavaScript library to make requests against a JMAP server. It is a client-side implementation of the JMAP specification. It is developed using ES6 and transpiled to ES5 code using babel.js.

Non-exhaustive list of features:

  • Entities are modeled as JavaScript classes.
  • Expose a Client class that you can use to send JMAP requests, using a fluent API.
  • Uses Promises exclusively, and allows for pluggable Promise implementation.
  • Allows for pluggable transports, with default support for node.js request and jQuery in the browser.

Usage

Installation

The library is provided as a NPM or Bower packages, thus to install either use:

npm install jmap-client

or

bower install jmap-client

depending on your preferred package manager.

How to contribute

1. Clone the repository

git clone https://ci.open-paas.org/stash/scm/olibs/jmap-client.git
cd jmap-client

2. Install dependencies

npm install

3. Compile the library and run the tests

grunt

4. Code, execute tests then pull request !

More detailled instructions can be found in the contributing section.

Release

If you are a maintainer of this project, here's how you can release a new version:

  1. Checkout the master branch and pull the latest changes from the remote repository
  2. Run grunt release to do the release. A lot of things will happen but you'll eventually be back on the master branch
  3. Bump the version in master to NEXT_VERSION-dev (replace NEXT_VERSION by the supposed next version)

License

MIT

jmap-client's People

Contributors

thomas-hilaire avatar jenkins-linagora avatar thomascube avatar ddolcimascolo avatar fvn-linagora avatar fabienmoyon avatar rockymeadow avatar michaelbailly avatar kscc25 avatar dbenchi avatar marclaporte avatar npa-old-deleted avatar gitter-badger avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.