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 Settings make your Cozy configuration easy to manage. Main features are:
- Connected devices management
- Storage information
Install and run in dev mode
Hacking the Settings app requires you to setup a dev environment.
You can then clone the app repository and install dependencies:
$ git clone https://github.com/cozy/cozy-settings.git $ cd cozy-settings $ yarn install
Cozy's apps use a standard set of npm scripts to run common tasks. You can so start you development workflow with:
$ cd cozy-settings $ yarn run watch:server
and point your browser to http://localhost:8090.
Run it inside the VM
You can easily view your current running app, you can use the cozy-stack docker image:
# in a terminal, run your app in watch mode $ cd cozy-settings $ yarn watch:browser
# in another terminal, run the docker container $ docker run --rm -it -p 8080:8080 -v "$(pwd)/build":/data/cozy-app/settings cozy/cozy-app-dev or $ yarn stack:docker
your app is available at http://settings.cozy.tools:8080.
Note about Cozy-ui
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 install yarn link
then go back to your app project and replace the distributed cozy-ui module with the linked one:
cd cozy-settings 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.
$ cd cozy-settings $ yarn test
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, Files, ...).
Whenever your app needs to use a given
doctype, you should:
- Check if this is a standard
doctypedefined 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
doctypewith your own customs fields. This is typically what is done in Konnectors for the Bill
- If no standards
doctypesfit your needs, you should define your own
doctypein 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
doctypedata could be reused by other apps. This is typically the case for the Konnector
Open a Pull-Request
If you want to work on Settings 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 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.
The lead maintainer for Cozy Settings is @CPatchane, send him/her a
Get in touch
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 Settings is developed by Cozy Cloud and distributed under the AGPL v3 license.