cozy-konnector-libs | cozy-jobs-cli | cozy-logger | renovate-config-cozy-konnector |
---|---|---|---|
Cozy Konnector monorepo
This package contains all the shared libs which can help the creation of a connector and also the CLI tools to run a connector outside a cozy.
-
View the interactive tutorial.
-
Check out Ameli connector for a real life konnector
-
Read the docs
- Read the list of existing connectors
If you want to work on Cozy Konnector Libs and submit code modifications, feel free to open pull-requests! See the contributing guide for more information about how to properly open pull-requests.
This repository is organized as a lerna monorepo. It facilitates developing focused packages that rely on each other.
cozy-konnector-libs
has tools to scrape and save data to your cozycozy-jobs-cli
lets your run a konnector/service while being authenticated to a cozycozy-logger
logs message in a human friendly way while developing and logs in JSON when in production. It can be used by konnector and services alike.renovate-config-cozy-konnector
is the Renovate preset for cozy konnectors.
To start developing :
$ git clone [email protected]:konnectors/libs.git cozy-konnector-libs
$ cd cozy-konnector-libs
$ yarn
$ yarn bootstrap # executes lerna under the hood and symlinks repositories
To publish a new version, those are the commands that can be used :
$ npx lerna updated # check if some packages need to be published
$ GH_TOKEN=xx...xx npx lerna publish # publish all packages
Useful documentation : https://github.com/lerna/lerna#publish
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.
The lead maintainer for Cozy Konnector Libs is doubleface, send him a 🍻 to say hello!
You can reach the Cozy Community by:
- Chatting with us on IRC #cozycloud on Libera.Chat
- Posting on our Forum
- Posting issues on the Github repos
- Say Hi! on Twitter
Cozy Konnector Libs is developed by Cozy Cloud and distributed under the MIT license.