Code Monkey home page Code Monkey logo

cozy-dev-docs's Introduction

⚠️ ⚠️ ⚠️ This doc is no longer used. Please go to https://github.com/cozy/cozy-docs-v3 ⚠️ ⚠️ ⚠️

Cozy Developer Documentation

Screenshot of the 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

  1. Fork this repository on Github.
  2. Clone your forked repository (not our original one) to your hard drive with git clone https://github.com/YOURUSERNAME/cozy-dev-docs.git
  3. cd cozy-dev-docs
  4. Install all dependencies: bundle install
  5. 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 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

cozy-dev-docs's People

Contributors

aenario avatar bootstraponline avatar chrissrogers avatar clochix avatar cvkef avatar felix-lambert avatar floorlamp avatar jsilvestre avatar kelukelu avatar kevin-buttercoin avatar kloadut avatar lord avatar m4dz avatar maks3w avatar martinsam avatar mattes avatar moizjv avatar niksamokhvalov avatar nono avatar pbechu avatar ptbrowne avatar realityking avatar rezanachmad avatar rlord avatar roukydesbois avatar sobstel avatar stetzer avatar styloa avatar swarzech avatar victorquinn avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

cozy-dev-docs's Issues

Update clientsideapp.md

In updateContactList() from the Vanilla JS part, the json don't need to be parsed, so we could remove the part:
var contacts = JSON.parse("" + res);

And we should emit doc instead of doc.n

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.