

Introduction

A Client-Side Konnector (also known as CliSK) is a script that imports data from another web service and put those data into your cozy. Each connector is an independent application, managed by the Twake Home application.

To protect your data, each connector runs inside a container in order to sandbox all their interactions with your data.

⚠️ For historical reasons, in the Twake codebase, a twake connector is named “konnector”, please follow this convention if modifying an existing application.

What will you need to start ?

• Node (20), follow the link to nodejs doc for proper installation. When it’s done, you can check your version with node --version in your shell.
• Yarn, again follow the Yarn doc for proper install. Check the version with yarn --version in your shell.

In this tutorial you will learn how to:

• Install the development environnement
• Create your first CliSK
• Understand how cozy-clisk library works
• Troubleshoot common issues with CliSK
• Code with Twake’s best practices
• Contribute to any other existing CliSK
• Join the Twake’s community