An example project using colonyJS with Angular!

This is a built out version of the colony-starter-angular package with more examples.


  • 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.


Globally install the colony-cli package.

yarn global add @colony/colony-cli

Install the colony-example-angular package.

colony build colony-example-angular

Alternatively, you can use npx and kickstart the colony-example-angular package in one line without having to add the colony-cli package:

npx -p @colony/colony-starter colony build colony-example-angular

Start Network

Open a new terminal window and start Ganache:

yarn start-ganache

Deploy Contracts

Open a new terminal window and deploy the colonyNetwork contracts:

yarn deploy-contracts

Start TrufflePig

Once the contracts have been deployed, start TrufflePig:

yarn start-trufflepig

Seed Network

Open a new terminal window and run the seed network script:

yarn seed-network

Start Server

Once the network has been seeded, start the development server:

yarn start

Open Browser

Open your browser and check out the example:


Run Tests

Open a new terminal window and run the example tests:

yarn test


Questions? Problems? Existential dilemmas? We’re here to help!

Improve this doc.

All improvements to documentation are welcome and encouraged. Submit a PR for documentation on GitHub.