Javascript library to write Cozy applications
JavaScript HTML
Pull request Compare This branch is 10 commits behind cozy:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dist
docs
src
test
.babelrc
.gitignore
.travis.yml
CONTRIBUTING.md
LICENSE
README.md
index.html
manifest.webapp
mocha-webpack.opts
package.json
webpack.config.js
yarn.lock

README.md

Travis build status shield NPM release version shield Github Release version shield NPM Licence shield

Cozy Javascript Client

What's Cozy?

Cozy Logo

Cozy is a platform that brings all your web services in the same private space. With it, your webapps and your devices can share data easily, providing you with a new experience. You can install Cozy on your own hardware where no one's tracking you.

What's cozy-client-js?

cozy-client-js is a javascript library made by Cozy. It enables client-side applications to make requests to the cozy stack.

cozy-client-js is compatible with both cozy architectures.

This repository is a work-in-progress where the cozy-stack companion javascript library is being developed.

To learn more about cozy-stack, head over to its repository.

If you are getting started on cozy application development, you should follow this tutorial and use the current cozy-browser-sdk. Transitioning from the cozy-browser-sdk library to this one should imply minimal changes (see transition doc)

Use

You can import/require cozy-client-js using webpack TODO test if cozy-client-js compatible with browserify, rollup, ect...

You can also copy-paste the dist/cozy-client.js bundle file into your application, and include it in your application with <script src="./cozy-client.js">.

polyfills : cozy-client-js uses fetch and bundle all necessary polyfills (promise, fetch, reGenerator). TODO: We should move the polyfills to a separate bundle and require them only if needed.

Once you have the library included in your application, head over to the doc to see what you can do with it!

Contribute

If you want to work on cozy-client-js itself and submit code modifications, feel free to open pull-requests! See the contributing guide for more information about this repository structure, testing, linting and how to properly open pull-requests.

Community

Maintainer

The lead maintainer for cozy-client-js is @aenario, send him/her a 🍻 to say hello!

Get in touch

You can reach the Cozy Community by:

Licence

cozy-client-js is developed by Cozy Cloud and distributed under the MIT.