Skip to content
This repository has been archived by the owner on Mar 11, 2024. It is now read-only.

Latest commit

 

History

History
72 lines (51 loc) · 2.85 KB

README.md

File metadata and controls

72 lines (51 loc) · 2.85 KB
Raw

⚠️ No new changes will be made to this box! There's good news though: 🤘 the uPort team maintains an official uPort Connect Truffle Box!. We recommend using that instead.

React, Redux and UPort Authentication Truffle Box

In addition to Webpack and React, this box adds: react-router, redux and redux-auth-wrapper for authentication powered by UPort. The easiest way to get started with UPort.

Installation

  1. Install Truffle globally.

    npm install -g truffle

  2. Download the box. This also takes care of installing the necessary dependencies.

    truffle unbox react-uport

  3. Run the development console.

    truffle develop

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

    compile
migrate

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

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

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

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

    npm run build

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.

  • 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. Either one would be a great place to start!