https://github.com/michyaraque/smart-contract-boilerplate

🚀 Boilerplate and Starter pack for develop Smart Contracts with Hardhat environment, Typescript, Chai and Waffle
https://github.com/michyaraque/smart-contract-boilerplate

blockchain chai hardhat javascript smart-contracts solidity typescript waffle web3

Last synced: 5 days ago
JSON representation

🚀 Boilerplate and Starter pack for develop Smart Contracts with Hardhat environment, Typescript, Chai and Waffle

• Host: GitHub
• URL: https://github.com/michyaraque/smart-contract-boilerplate
• Owner: michyaraque
• Created: 2022-08-07T15:30:17.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-11-04T21:26:18.000Z (about 2 years ago)
• Last Synced: 2024-11-17T00:44:25.042Z (2 months ago)
• Topics: blockchain, chai, hardhat, javascript, smart-contracts, solidity, typescript, waffle, web3
• Language: TypeScript
• Homepage: https://michyaraque.dev
• Size: 174 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  ⚙️📋 Smart Contract Boilerplate, TS, Chai, Waffle





    

    

    

    

    



## 🔋⚡ Smart Contract battery template

This is a boilerplate for create a solid smart contracts with [Solidity](https://solidity.readthedocs.io/), [Hardhat](https://hardhat.org/), [Typescript](https://typescript.com), [Chai](https://www.chaijs.com/) and [Waffle](https://ethereum-waffle.readthedocs.io/)

### 🚀 Easy test Deployments



    

    



- ✔️ Toolings for linting, formatting, and conventions configured

  `solhint`, `eslint` and `prettier`

### Features

- 👷 [Hardhat](https://hardhat.org/) environment

- 🔥 Type checking [Typescript](https://www.typescriptlang.org/)

- For testing:

    - Chai

    - Waffle

## Getting started

You can either click `Use this template` button on this repository and clone the repo or directly from your terminal:

```bash

npx degit michyaraque/smart-contract-boilerplate 

```

- Run `yarn install` in the root directory.

- Change `.env.example` to `.env` and put your private key on the key PRIVATE_KEY_DEPLOYER

## Unit Tests

Run `npx hardhat test` to run the unit tests.

## Get Coverage Diagnostic

Run `npx hardhat coverage` to get the actual testing coverage.