Hardhat TypeScript Template

A simple hardhat template.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgements

About The Project

A simple foundry and hardhat hybrid template modeled off of running npx hardhat init and forge init --force.

Simple enough to be get off the ground running for a hackathon project with strong enough of a foundation to be extended to be used for serious projects to be deployed in prod.

This project includes:

• TDD support w/ Nodemon
• Prettier formatting customization
• Test coverage
• Typechain types generation for TS projects
• Hardhat contract verification

Built With

• hardhat
• foundry

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

You need to have npm/pnpm/yarn to use this project.

• npm

  npm install npm@latest -g

You will probably also need node.

Installation

1. Clone the repo

   git clone https://github.com/0xdavinchee/foundry-hardhat-template.git

2. Install NPM packages

   pnpm install

Usage

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

0xdavinchee - @0xdavinchee - [email protected]

Project Link: https://github.com/0xdavinchee/foundry-hardhat-template

Acknowledgements

• Hardhat
• foundry