colony-example-react

An example project using colonyJS using React!

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

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.

Installation

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-example-react package:

colony build colony-example-react

Step 3

Move to your new project directory and follow the instructions below:

cd colony-example-react

Using NPX

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

npx -p @colony/colony-cli colony build colony-example-react

Development

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:

http://localhost:3000

Run Tests

Open a new terminal window and run the example tests:

yarn test

Contract Versions

If you do not want to use the default version of the colonyNetwork smart contracts defined by the colony-cli package, you can update the "deploy-contracts" scripts property in your package.json file to use a specific version. This can be a branch name, a commit hash, or a version tag.

"deploy-contracts": "colony service deploy-contracts --specific glider",