Skip to content
This repository has been archived by the owner on Feb 15, 2019. It is now read-only.
/ cozy-onboarding-v3 Public archive

Onboarding client application working with cozy-stack v3

License

Notifications You must be signed in to change notification settings

cozy/cozy-onboarding-v3

Repository files navigation

Deprecated

This repository was used for the onboarding application of Cozy Cloud. It has been deprecated: the onboarding is no longer an application, it has been merged as a page of cozy-stack.


Travis build status shield Github Release version shield

Cozy Onboarding

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.

What's Onboarding?

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

Hack

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
$ yarn install
$ yarn watch

Tests

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.

Open a Pull-Request

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.

Community

Localization

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.

Get in touch

You can reach the Cozy Community by:

License

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