Learn to build with Colony
ryanchristo Publish
 - @colony/colony-starter-react@1.0.0-beta.3
Latest commit 38f357f Dec 8, 2018

README.md

Colony Starter

Learn to build with Colony! Get a head start on your next project! Colony Starter (formerly known as "Hackathon Starter") includes a variety of starter projects that demonstrate how to use and integrate different tools with Colony.

Get Started

Prerequisites

  • Yarn 1.12.3
  • Docker
  • Node 10.12.0

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

If you are using Linux, check out the Linux Setup page to ensure Yarn and Docker are set up accordingly.

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

Alternatively, you can use npx and kickstart the colony-starter-basic package in one line without having to globally install the colony-starter package:

npx -p @colony/colony-starter colony-starter colony-starter-basic

Step 3

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

cd colony-starter-basic

Starter Projects

Now that you have a basic understanding of how Colony works, check out some of the other starter projects by repeating steps 2 and 3 and substituting colony-starter-basic with the project of your choice!

Contribute

Are you interested in contributing? Check out the following documents for more information: