Options
All
  • Public
  • Public/Protected
  • All
Menu

The Collaborative Illustrator — Documentation

The Collaborative Illustrator Build Status

The Collaborative Illustrator is a simplified illustrator allowing collaboration between peers with WebRTC.

▶️ Collaborative Illustrator web application

📖 Collaborative Illustrator Documentation

Building process

The Collaborative Illustrator is written in TypeScript, a language that can be compile to JavaScript. It uses D3 for manipulating the DOM and Browserify to pack all the output JavaScript files into a single script.

To build it on your own machine, you need npm.

Once this is done, open a terminal and run the following commands:

  1. git clone https://github.com/AChaffangeon/collaborative-illustrator.git to clone this repository.
  2. cd collaborative-illustrator to change you working directory to the clone you just made.
  3. npm install -g grunt-cli to install the CLI of Grunt, the build system we use.
  4. npm install to install all the other dependencies (listed in package.json).
  5. grunt to finally build the application.

The build folder will contain your own build.

To create your own documentation, use grunt make-doc at the root of the project.

Generated using TypeDoc