Practical overview
When it fits
Use it at the beginning of an Ethereum Solidity project when a ready-made Hardhat structure and common development checks are more useful than configuring each tool from scratch.
Who it is for
- Developers starting an Ethereum Solidity smart-contract project.
- Teams seeking prepared testing, linting, coverage and continuous-integration configuration.
- Developers who want a local, Gitpod or VSCode-oriented starting workspace.
Documented uses
- Create a new repository from a Hardhat project template.
- Compile Solidity contracts and generate TypeScript bindings.
- Run contract tests, Solidity and TypeScript linting, coverage and gas reporting.
- Deploy example contracts to Hardhat Network or use a documented local Ganache workflow.
- Automate linting and testing through the included GitHub Actions configuration.
Requirements & limits
The repository is public and identified as MIT licensed.
- The template uses Bun commands for installation and project scripts.
- It includes Hardhat, TypeChain, ethers, Solhint, Solidity coverage and Prettier Solidity integration.
- GitHub Actions checks are configured for pushes and pull requests to main.
- Custom network or deployment use requires setting the relevant Hardhat configuration variables.
- The documented foundation is TypeScript, while the contracts are written in Solidity.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Create and validate a Solidity project from the template
Create a new repository from the template and run its documented compile, binding-generation, test and lint stages.
Before you start
- A GitHub account or access to the repository's Use this template action.
- Bun installed for the documented dependency and script commands.
- Hardhat configuration variables set with the documented Hardhat variables workflow.
Steps
Click Use this template on the repository to create a new repository with the template as its initial state.
Install dependencies with
bun install.Set required variables with
bunx hardhat vars setup, or set an individual value withbunx hardhat vars set MNEMONIC.Compile and generate bindings with
bun run compileandbun run typechain.Run
bun run test,bun run lint:solandbun run lint:ts.
Expected outcome
A new Solidity project can be compiled, checked, tested and supplied with TypeChain bindings using the documented template workflow.
Guide limitations
- The supplied documentation does not specify project-specific contracts or tests beyond the included example material.
- Required Hardhat configuration variables depend on the project's configuration.
- The guide documents commands and workflow but does not provide a verification result for a particular environment.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 1 October 2026
- Original website title
- PaulRBerg/hardhat-template · Official homepage title · retained in its source language

