/hardhat-starter-kit

🦧 An advanced solidity + hardhat + typescript boilerplate repo

Primary LanguageTypeScript

🎎 Hardhat Starter Kit

🎫 Instrutions

To start, click on the green use this template button on the top bar and start building your project 😀.

👨‍💻 Package Scripts

test

yarn test Run all tests specified in the test/ folder.

build

yarn build Generate all contract's artifacts and types.

lint

yarn deploy Deploy all contracts specified in the deploy/ folder.

format

yarn format Run prettier to format all the code.

lint

yarn lint Fix all code issues in contracts, tests and scripts.

ci

yarn ci Trigger a watcher for your tests and contracts to clean, build and test on the run.

docs

yarn docs Generate markdown docs for your contracts.

clean

yarn clean Remove all build directories, preparing for another compiling.

🌲 Folder Structure

This template uses the root folder as the base path and contains folders such as contracts, test and tasks to speed up your performance and development.

📘 contracts/

This is where you should put all your .sol files.

🧪 tests/

This is where you should put all your test files.

🚀 deploy/

The folder where all your deploy scripts should live.

🤖 Made by bots | 🔬 naomsa.eth