colony-starter-react
A boilerplate to get started with colonyJS using React!
Prerequisites
- Node
>=10.12.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
Globally install the colony-cli package.
yarn global add @colony/colony-cliInstall the colony-starter-react package.
colony build colony-starter-reactAlternatively, you can use npx and kickstart the colony-starter-react package in one line without having to globally add the colony-cli package:
npx -p @colony/colony-starter colony build colony-starter-reactStart Network
Open a new terminal window and start Ganache:
yarn start-ganacheDeploy Contracts
Open a new terminal window and deploy the colonyNetwork contracts:
yarn deploy-contractsStart TrufflePig
Once the contracts have been deployed, start TrufflePig:
yarn start-trufflepigSeed Network
Open a new terminal window and run the seed network script:
yarn seed-networkColony Setup
Once the network has been seeded, run the colony setup script:
yarn colony-setupStart Server
Once your test colony has been set up, start the development server:
yarn startOpen Browser
Open your browser and check out the example react app:
Run Tests
Open a new terminal window and run the example tests:
yarn testSupport
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.