Overview

About

Learn to build with Colony! Get a head start on your next project! colonyStarter includes a variety of starter projects that demonstrate how to use and integrate different tools with Colony. You can start building with Colony by installing one of our starter projects with just a few simple commands!

Get Started

Prerequisites

  • Yarn
  • Docker
  • Node 9.10

You may find it helpful to use Node Version Manager (nvm) to manage node versions.

Step 1

Globally install the colony-starter package:

yarn global add @colony/colony-starter

Step 2

Move to your working directory and unpack the colony-starter-basic package:

colony-starter colony-starter-basic

Step 3

Move to your new project directory and checkout the colony-starter-basic instructions:

cd colony-starter-basic

Contribute

colonyStarter is under active development and packages are constantly being added and updated. If you notice a discrepancy in the documentation on this site or a bug in the code, check out the following documents for more information: