A simple, yet effective starting point for your Solidity projects.

Features

• Clear and concise project structure
• TypeScript integration for enhanced developer experience
• Solidity and Github actions CI
• Hardhat configuration for compilation, testing, deployment, and more
• Solhint integration for linting and code quality checks
• Basic testing setup using Mocha and Chai

• Solidity Boilerplate
  • TOC
  • Getting Started
  • Project Structure
  • Contribute
  • License

1. Clone the repository:

git clone https://github.com/jhelison/solidity-boilerplate.git

2. Install dependencies:

cd solidity-boilerplate
yarn install

3. Compile contracts:

yarn compile

4. Run tests:

yarn test

5. Deploy contracts (optional):

• Configure your desired network in hardhat.config.ts.
• Use Hardhat tasks for deployment.

solidity-boilerplate/
├── contracts/              # Solidity contracts
├── scripts/                # Hardhat scripts
├── test/                   # Tests
├── package.json            # Project dependencies
├── hardhat.config.ts       # Hardhat configuration
├── solhint.json            # Solhint configuration
└── README.md               # This file

Contributions are welcome. Please open an issue or submit a pull request with your proposed changes.

This project is open-sourced software licensed under the MIT License.