decentfund / weekendplanner

0 stars 0 forks source link

Weekend planner dApp for EVM

Project is based on Truffle suite and its Drizzle box.

Installation

  1. Install Truffle and Ganache CLI globally. If you prefer, the graphical version of Ganache works as well!

    npm install -g truffle
    npm install -g ganache-cli
  2. Run the development blockchain, we recommend passing in a blocktime. Otherwise, its difficult to track things like loading indicators because Ganache will mine instantly.

    // 3 second blocktime.
    ganache-cli -b 3
  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.

Verify that your metamask is connected to correct local testnet port running in ganache-cli

    // Serves the front-end on http://localhost:3000
    npm run start
  1. Run the storybook server.

    // Serves the storybook on http://localhost:9001
    npm run storybook
  2. 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
  3. 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
  4. To build the application for production, use the build command. A production build will be in the build_webpack folder.

    npm run build