Secure the networkBug Bounty 2019

colony-starter-react

About

The colony-starter-react package is a starter project that demonstrates how to use colonyJS (a JavaScript client for colonyNetwork) with react, redux and webpack. This project is set up to start a local test network using Ganache and then deploy the colonyNetwork contracts to the local test network using Truffle. This project also uses TrufflePig to find and read the deployed contracts during local development.

This project includes example scripts also found in the colonyJS Docs. In order to help you hit the ground running with your new project, this starter project includes all of the examples that can be called through interactions with a simple user interface.

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.

Installation

Globally install the colony-starter package.

yarn global add @colony/colony-starter

Install the colony-starter-react package.

colony-starter colony-starter-react

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

npx -p @colony/colony-starter colony-starter colony-starter-react

Run Examples

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 Webpack Dev Server

Once the network has been seeded, start webpack-dev-server:

yarn start

Open Your Browser

Open your browser and checkout the example react app::

localhost:8080

Run Example Tests

Open a new terminal window and run the example tests:

yarn test