VARS TO REPLACE IN TEMPLATE:

** REMOVE THIS SECTION BEFORE PUBLISHING**

• Onboarding: the application name
• <APP_PORT>: app running port
• cozy-onboarding-v3: transifex app slug
• cozy-onboarding-v3: Github repository slugname

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.

Cozy Onboarding helps users to register and configure their cozy the first time they access to it.

To be hacked, the Cozy Proxy dev environment requires that a CouchDB instance and a Cozy Data System instance are running. Then you can start the Cozy Proxy this way:

$ git clone https://github.com/cozy/cozy-onboarding-v3.git
$ cd cozy-onboarding-v3
$ npm install
$ npm run watch

• Forward cozy-home application port from the virtual machine: config.vm.network :forwarded_port, guest: 9103, host: 9103 in file Vagrantfile (if the virtual machine is already up, you can apply this change with vagrant reload)
• On your computer, go to your cozy-onboarding-v3 folder cd your-cozy-onboarding-v3-folder
• Run npm install
• Once install is done, launch cozy-onboarding-v3 PORT=9555 HOST="0.0.0.0" npm run watch (You may use another port)
• You can now access the hacked proxy on http://localhost:9555 with your navigator

Cozy-ui is our frontend stack library that provides common styles and components accross the whole Cozy's apps. You can use it for you own application to follow the official Cozy's guidelines and styles. If you need to develop / hack cozy-ui, it's sometimes more useful to develop on it through another app. You can do it by cloning cozy-ui locally and link it to yarn local index:

git clone https://github.com/cozy/cozy-ui.git
cd cozy-ui
yarn link

then go back to your app project and replace the distributed cozy-ui module with the linked one:

cd cozy-onboarding-v3
yarn link cozy-ui

You can now run the watch task and your project will hot-reload each times a cozy-ui source file is touched.

You can easily view your current running app in your VM, use cozy-dev:

# in a terminal, run your app in watch mode
$ cd cozy-onboarding-v3
$ yarn run watch

# in another terminal, install cozy-dev (first time) and run the deploy
$ cd cozy-onboarding-v3
$ yarn global install cozy-dev
$ cozy-dev deploy <APP_PORT>

your app is available in your vm dashboard at http://localhost:9104.

Tests are run by mocha under the hood, and written using chai and sinon. You can easily run the tests suite with:

$ cd cozy-onboarding-v3
$ yarn test

📌 Don't forget to update / create new tests when you contribute to code to keep the app the consistent.

The Cozy datastore stores documents, which can be seen as JSON objects. A doctype is simply a declaration of the fields in a given JSON object, to store similar objects in an homogeneous fashion.

Cozy ships a built-in list of doctypes for representation of most of the common documents (Bills, Contacts, Events, ...).

Whenever your app needs to use a given doctype, you should:

• Check if this is a standard doctype defined in Cozy itself. If this is the case, you should add a model declaration in your app containing at least the fields listed in the main fields list for this doctype. Note that you can extend the Cozy-provided doctype with your own customs fields. This is typically what is done in Konnectors for the Bill doctype.
• If no standards doctypes fit your needs, you should define your own doctype in your app. In this case, you do not have to put any field you want in your model, but you should crosscheck other cozy apps to try to homogeneize the names of your fields, so that your doctype data could be reused by other apps. This is typically the case for the Konnector doctype in Konnectors.

All documentation is located in the /docs app directory. It provides an exhaustive documentation about workflows (installation, development, pull-requests…), architecture, code consistency, data structures, dependencies, and more.

Feel free to read it and fix / update it if needed, all comments and feedback to improve it are welcome!

If you want to work on Onboarding and submit code modifications, feel free to open pull-requests! See the contributing guide for more information about how to properly open pull-requests.

Localization and translations are handled by Transifex, which is used by all Cozy's apps.

As a translator, you can login to Transifex (using your Github account) and claim an access to the app repository. Locales are pulled when app is build before publishing.

As a developer, you must configure the transifex client, and claim an access as maintainer is the app repository. Then please only update the source locale file (usually en.json in client and/or server parts), and push it to Transifex repository using the tx push -s command.

You can reach the Cozy Community by:

• Chatting with us on IRC #cozycloud on Freenode
• Posting on our Forum
• Posting issues on the Github repos
• Say Hi! on Twitter

Cozy Onboarding is developed by Cozy Cloud and distributed under the AGPL v3 license.