cozy-dev-docs's Introduction

Cozy Developer Documentation

Check it out at dev.cozy.io/.

Running and editing the documentation

Prerequisites

You're going to need:

Linux or OS X — Windows may work, but is unsupported.
Ruby, version 1.9.3 or newer
Bundler — If Ruby is already installed, but the bundle command doesn't work, just run gem install bundler in a terminal.

Getting Set Up

Fork this repository on Github.
Clone your forked repository (not our original one) to your hard drive with git clone https://github.com/YOURUSERNAME/cozy-dev-docs.git
cd cozy-dev-docs
Install all dependencies: bundle install
Start the test server: EXECJS_RUNTIME=Node bundle exec middleman

Or use the included Dockerfile! (must install Docker first)

docker build -t cozy-doc .
docker run -d -p 4567:4567 cozy-doc

You can now see the docs at http://localhost:4567. Whoa! That was fast!

Note: if you're using the Docker setup on OSX, the docs will be availalable at the output of boot2docker ip instead of localhost:4567.

Now that the doc is all set up your machine, you'll probably want to learn more about editing markdown.

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.