/cozy-site

Official repository for the Cozy website.

Primary LanguageHTML

Cozy Website sources

Hack

setup

Clone this repository then install dependencies:

npm i

build

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

NPM

npm run build
npm run build:fr

Yarn

yarn build
yarn build:fr

The result will be stored in a folder named build.

How to start the development server

NPM

npm run dev
npm run dev:fr
npm run dev:es

Yarn

yarn dev
yarn dev:fr
yarn dev:es

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

We use JSON key-value files to store all the locales, and Transifex to translate the website. These files are located inside the src/locales folder. To prevent conflicts, please avoid updating this files directly, but prefer to edit them on Transifex.

  • To translate the Website, go to Transifex;
  • To test your translations, install the Transifex client and run tx pull inside the root directory, the rebuild the site.

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 Logo

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.freenode.net
  • Posting on our Forum
  • Posting issues on the Github repos
  • Mentioning us on Twitter