DEPRECATION NOTICE

This project has been retired. Please use colonyJS directly. Thank you.

Colony Starter

Get a head start on your next project! Colony Starter (formerly known as "Hackathon Starter") includes a variety of boilerplates and example projects that will help you get started with Colony.

Get Started

Prerequisites

• Node >=10.13.0
• Yarn >=1.12.0
• Docker >=18.09.0

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

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

Step 1

Globally install the colony-cli package:

yarn global add @colony/colony-cli

Step 2

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

colony build colony-starter

Step 3

Move to your new project directory and check out the colony-starter readme for further instructions:

cd colony-starter

Using NPX

Alternatively, you can use npx and unpack the colony-starter package without installing the colony-cli package.

npx -p @colony/colony-cli colony build colony-starter

Packages

Colony CLI

The colony-cli package is a command line tool for building colonyStarter packages and running services such as Ganache, Truffle, and Trufflepig to assist with local development alongside the colonyNetwork smart contracts.

Starter Packages

Check out some of the other starter packages by repeating steps 2 and 3 and substituting colony-starter with the package of your choice. If you have ideas for new packages or improvements, feel free to open an issue or pull request.

colony-starter

• A boilerplate using colonyJS.

colony-starter-react

• A boilerplate using colonyJS with React.

colony-starter-angular

• A boilerplate using colonyJS with Angular.

colony-starter-vue

• A boilerplate using colonyJS with Vue.

colony-starter-contract

• A boilerplate to start building extension contracts alongside colonyNetwork.

Example Packages

We also have a couple example packages that you can unpack using the same build command. If you are uncertain how to do something, it might be helpful to use one of these packages as a reference.

colony-example

• A built out version of the colony-starter package with more examples.

colony-example-react

• A built out version of the colony-starter-react package with more examples.

colony-example-angular

• A built out version of the colony-starter-angular package with more examples.
• This package was built by the community! Special thanks to @fuguefoundation!

colony-example-vue

• A built out version of the colony-starter-vue package with more examples.
• This package was built by the community! Special thanks to @zzyyxxww!

Contribute

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

• Contributing
• Development