Settings app for Cozy Cloud
Clone or download
CPatchane Merge pull request #152 from cozy/renovate/major-react-monorepo
chore(deps): update dependency react-test-renderer to v16
Latest commit 69b05b5 Jan 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.tx [chore] Add structure customised from cozy-template Jan 4, 2017
config chore: add config and modules to handle next intent services 🔧 Jul 18, 2017
deploy chore: Configure downcloud upload ⚙ Aug 27, 2018
src fix: 🐛 Markdown link styles Dec 14, 2018
test test: 🔧 Add some tests Dec 14, 2018
.editorconfig chore: Add a contributing guide and a template for PRs 📓 May 19, 2017
.eslintrc.json fix: 🚨 Fix all linting issues Dec 12, 2018
.gitignore chore: Add a contributing guide and a template for PRs 📓 May 19, 2017
.transifexrc.tpl chore: Add a contributing guide and a template for PRs 📓 May 19, 2017
.travis.yml chore: Remove rundeck postpublish hook ⚙ Oct 10, 2018
CONTRIBUTING.md chore: fix git repositories in the contributing guide 📓 May 22, 2017
LICENSE chore: Add a contributing guide and a template for PRs 📓 May 19, 2017
PULL_REQUEST_TEMPLATE.md chore: Add a contributing guide and a template for PRs 📓 May 19, 2017
README.md fix: update link to dev doc (#140) Nov 26, 2018
app.config.js feat: Upgrade the app to use the last cozy-scripts Dec 14, 2018
babel.config.js test: 🔧 Add some tests Dec 14, 2018
jest.config.js feat: 🔧 Use test script from cozy-scripts with babel cozy-app Dec 12, 2018
manifest.webapp feat: Upgrade the app to use the last cozy-scripts Dec 14, 2018
package.json Merge pull request #152 from cozy/renovate/major-react-monorepo Jan 15, 2019
renovate.json Use cozy renovate config Dec 17, 2018
webpack.config.js chore: Add a contributing guide and a template for PRs 📓 May 19, 2017
yarn.lock Merge pull request #152 from cozy/renovate/major-react-monorepo Jan 15, 2019

README.md

Travis build status shield NPM release version shield Github Release version shield NPM Licence shield

Cozy Settings

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 Settings?

Cozy Settings make your Cozy configuration easy to manage. Main features are:

  • Account management
  • Connected devices management
  • Storage information

Hack

📌 Note: we recommend to use Yarn instead of NPM for package management. Don't hesitate to install and use it for your Cozy projects, it's now our main node packages tool for Cozy official apps.

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

📌 If you use a node environment wrapper like nvm or ndenv, don't forget to set your local node version before doing a 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.

Cozy-client-js is our API library that provides an unified API on top of the cozy-stack. If you need to develop / hack cozy-client-js in parallel of your application, you can use the same trick that we used with cozy-ui: yarn linking.

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-settings
$ yarn test

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

Models

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 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.

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.

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.

Maintainer

The lead maintainer for Cozy Settings is @CPatchane, send him/her a 🍻 to say hello!

Get in touch

You can reach the Cozy Community by:

License

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