Cozy Website sources

Develop

⚠️ This project requires node 10 and will not compile with node 12+. Currently, you need to use Node 8 if you plan to use yarn. Using yarn with node 10 will lead to a nodejs stacktrace. Node 10 works perfectly fine if you don't use yarn.

setup

Clone this repository then install dependencies:

yarn install

or with node 10:

npm install

build

To run the build properly you will need at least Node.js v4.0.

yarn build
yarn build:fr
yarn build:es

or with node 10:

node output.js
node output-fr.js
node output-es.js

The result will be stored in a folder named build.

How to start the development server

yarn dev
yarn dev:fr
yarn dev:es

or with node 10:

node output.js --dev
node output-fr.js --dev
node output-es.js --dev

This command will run:

• a web server that serves your static built files on the 3000 port.
• a watcher that will rebuild your files and update your locale keys eacht time you change something.

Check http://localhost:3000/en/ to start browsing!

Locales

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. Transifex will then create pull request on the repository, and the locales are merged after validating the pull request.

As a developer, you just have to modify json in /src/locales. New locales will be automatically added to Transifex. If you need to pull or push manually locales, you can use Transifex CLI. If you were using a transifex-client, you must move to Transifex CLI to be compatible with the v3 API.

Application page

The application is automatically generated. It's done via two scripts located in the utils folder. Here is the script to download icons from the app registry and build the app page from the Cozy registry information:

cd utils
node app-images.js
node app.js

Extra information

• The build engine of the website is based on Metalsmith (a static website generator).
• The templates are written with Handlebars.
• Stylesheets are written with Stylus

What is Cozy?

Cozy is a platform that brings all your web services in the same private space. With it, your web apps and your devices can share data easily, providing you with a new experience. You can install Cozy on your own hardware where no one profiles you.

Community

You can reach the Cozy Community by:

• Chatting with us on IRC #cozycloud on irc.libera.chat
• Posting on our Forum
• Posting issues on the Github repos
• Mentioning us on Twitter