sirrodgepodge / truffle-react-sockets-box

Truffle, Webpack, React, Redux boilerplate with smart contract events and sockets. https://truffle-box.github.io/

React, Redux, Sockets, and Blog Truffle Box

In addition to Webpack and React, this box adds: react-router, redux and socket.io for a twitter-style blog powered by a smart contract. This is a great example of how to make a real-time web application that is subscribes to blockchain events and pushes updates to the front end.

Installation

1. Clone this repo locally

2. Install Truffle globally.

   npm install -g truffle

3. Compile and migrate the smart contracts. Note inside the development console we don't preface commands with truffle.

   compile
   migrate

4. Run the webpack server for front-end hot reloading (outside the development console). Smart contract changes must be manually recompiled and migrated.

   // Serves the front-end on http://localhost:3000
   npm run start

5. Truffle can run tests written in Solidity or JavaScript against your smart contracts. Note the command varies slightly if you're in or outside of the development console.

   // If inside the development console.
   test
   
   // If outside the development console..
   truffle test

6. Jest is included for testing React components. Compile your contracts before running Jest, or you may receive some file not found errors.

   // Run Jest outside of the development console for front-end component tests.
   npm run test

7. To build the application for production, use the build command. A production build will be in the build_webpack folder.

   npm run build

8. Once built, this application may be run in production with the following command.

   npm run prod

FAQ

• How do I use this with the EthereumJS TestRPC?

  It's as easy as modifying the config file! Check out our documentation on adding network configurations. Depending on the port you're using, you'll also need to update line 34 of src/util/web3/getWeb3.js.

• Why is there both a truffle.js file and a truffle-config.js file?

  truffle-config.js is a copy of truffle.js for compatibility with Windows development environments. Feel free to it if it's irrelevant to your platform.

• Where is my production build?

  The production build will be in the build_webpack folder. This is because Truffle outputs contract compilations to the build folder.

• Where can I find more documentation?

  This box is a marriage of Truffle and a React setup created with create-react-app, and for simply pushing blockchain events to the front end, good 'ol socket.io. Either one would be a great place to start!