Skip to content

YutaSugimura/truffle-react-typescript

Repository files navigation

Truffle React Hooks TypeScript Template

This box comes with everything you need to start using smart contracts from a react app. This is as barebones as it gets, so nothing stands in your way.

Installation

  1. First of all, do a git clone to bring this repository locally
    git clone https://github.com/YutaSugimura/truffle-react-typescript.git

Delete /test/simpleStorage.test.ts and /contracts/SimpleStorage.sol and create your own contract

  1. Installing truffle.

     npm install -g truffle
  2. Installing the library

     yarn install
     # or
     npm i
  3. Compiling Contracts.
    Compile the smart contract.

    yarn compile
  4. Run the development console.

    truffle develop
  5. In the client directory, we run the React app. Smart contract changes must be manually recompiled and migrated.

    # in another terminal (i.e. not in the truffle develop prompt)
    cd client
    # install dependencies
    npm install
    # or
    yarn install
    npm start
    # or
    yarn start
  6. Using ethereum-waffle to test smart contracts

    yarn test
    
    # or
    npm run test
  7. Jest is included for testing React components. Compile your contracts before running Jest, or you may receive some file not found errors.

    # ensure you are inside the client directory when running this
    npm run test
    # or
    yarn test
  8. To build the application for production, use the build script. A production build will be in the client/build folder.

    # ensure you are inside the client directory when running this
    npm run build
    # or
    yarn build