cozy-client-js
Version:
Javascript library to interact with a cozy
48 lines (30 loc) • 2.33 kB
Markdown
[](https://travis-ci.org/cozy/cozy-client-js)
[](https://www.npmjs.com/package/cozy-client-js)
[](https://github.com/cozy/cozy-client-js/blob/master/LICENSE)
⚠️ This is the documentation for the old version of cozy-client. [Go to the new version](http://github.com/cozy/cozy-client) ✅.
# [Cozy][cozy] Javascript Client
## What's Cozy?

[Cozy][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 applications (client-side apps, konnectors, OAuth apps, etc.) to make requests to the cozy stack.
If you are getting started on cozy application development, you should follow this [tutorial](https://docs.cozy.io/en/dev/app/). [The reference documentation](https://docs.cozy.io/en/cozy-client-js/README/) is the place to see what you can do with this lib, and how to do 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][contribute] for more information about this repository structure, testing, linting and how to properly open pull-requests.
## Community
### Get in touch
You can reach the Cozy Community by:
- Chatting with us on IRC [#cozycloud on Libera.Chat][libera]
- Posting on our [Forum][forum]
- Posting issues on the [Github repos][github]
- Say Hi! on [Twitter][twitter]
## Licence
cozy-client-js is developed by Cozy Cloud and distributed under the [MIT][mit].
[cozy]: https://cozy.io 'Cozy Cloud'
[doctypes]: https://cozy.github.io/cozy-doctypes/
[mit]: https://opensource.org/licenses/MIT
[contribute]: CONTRIBUTING.md
[libera]: https://web.libera.chat/#cozycloud
[forum]: https://forum.cozy.io/
[github]: https://github.com/cozy/
[twitter]: https://twitter.com/cozycloud