README.md

"Hello dApp!" Development Workshop

MVP (Minimal Viable Preparation) for dApp developers.

This is a one-stop hands-on tutorial for first-time Ethereum application developers.

• Warm up
• Hardhat 101
• Smart Contracts Boilerplate
• Resources
• Contributing

Hello-dApp

In this section, we demonstrates a minimal viable preparation for dApp construction using latest Hardhat developement framework. It comes with a Lock contract, a simple web app where user can lock some money when deploying that contract and then withraw when time is after the specified locking timestamp or after unlock operation.

Detailed instruction can be checked at README.

Hardhat 101

In this section, we aim to familiarize you with a powerful and modern development tool hardhat. Since we only need the basics to kick-start our own project, going through the "Getting Started" section of the official documentation is strongly recommended.

Make a new folder to play with hardhat basics:

# First clone our repo
git clone [email protected]:BlockchainCourseNTU/hello-dapp.git && cd hello-dapp

# make sure you are in project root, then make a new package
mkdir -p packages/hardhat-101/ && cd packages/hardhat-101/
npm init -y

# then proceed with hardhat installation: https://hardhat.org/getting-started/#installation

Smart contracts boilerplate

In this section, we aim to build a boilerplate for all your future Solidity projects by gradually introducing essential hardhat plugins and npm packages that are useful and widely used in the development cycle.

• Building Smart Contract Project Boilerplate (Part 1)
  • Prerequisites
  • Hardhat Typescript sample project
    • Add TypeScript support
  • Add OpenZeppelin dependency
  • Add code formatting and linting
  • Add test coverage
  • Add gas reporter
  • Add contract sizer
  • Add commit lint and git hooks
  • Add TypeChain support
  • Add deployment plugins
• Building Smart Contract Project Boilerplate (Part 2)
  • Testing with waffle
  • Mocking with smock
  • Special testing: Moving in time
  • Special testing: Mainnet Forking

Resources

• a slightly more complex solidity-boilerplate by defi-wonderland

Contributing

Current maintainers are Liu Ye and Palina Tolmach.

Thanks for the contribution from Alex Xiong, Gwyneth Ang, and Dr. Sourav Gupta.

Feel free to submit issues or PR for bugs or other requests.