Skip to content

Latest commit

 

History

History
92 lines (61 loc) · 3.92 KB

README.md

File metadata and controls

92 lines (61 loc) · 3.92 KB
Raw

Travis build status shield NPM Licence shield

cozy-konnector-libs cozy-jobs-cli cozy-logger renovate-config-cozy-konnector
NPM release cozy-konnector-libs NPM release cozy-jobs-cli NPM release cozy-logger NPM release 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.

  1. View the interactive tutorial.

  2. Check out Ameli connector for a real life konnector

  3. Read the docs

  1. Read the list of existing connectors

Contributing

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.

Lerna

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 cozy
  • cozy-jobs-cli lets your run a konnector/service while being authenticated to a cozy
  • cozy-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 git@github.com: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

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.

Community

Maintainer

The lead maintainer for Cozy Konnector Libs is doubleface, send him a 🍻 to say hello!

Get in touch

You can reach the Cozy Community by:

License

Cozy Konnector Libs is developed by Cozy Cloud and distributed under the MIT license.