Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/antoncoding/gas-playground
https://github.com/antoncoding/gas-playground
Last synced: 20 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/antoncoding/gas-playground
- Owner: antoncoding
- Created: 2022-03-10T17:00:06.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-07-03T16:18:09.000Z (over 1 year ago)
- Last Synced: 2024-10-07T06:06:58.393Z (about 1 month ago)
- Language: Solidity
- Size: 308 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Forge Template
A template for quickly getting started with forge
## Getting Started
```
mkdir my-project
cd my-project
forge init --template https://github.com/FrankieIsLost/forge-template
git submodule update --init --recursive ## initialize submodule dependencies
npm install ## install development dependencies
forge build
forge test
```
## Features
### Testing Utilities
Includes a `Utilities.sol` contract with common testing methods (like creating users with an initial balance), as well as various other utility contracts.
### Preinstalled dependencies
`ds-test` for testing, `forge-std` for better cheatcode UX, and `solmate` for optimized contract implementations.
### Linting
Pre-configured `solhint` and `prettier-plugin-solidity`. Can be run by
```
npm run solhint
npm run prettier
```
### CI with Github Actions
Automatically run linting and tests on pull requests.
### Default Configuration
Including `.gitignore`, `.vscode`, `remappings.txt`
## Acknowledgement
Inspired by great dapptools templates like https://github.com/gakonst/forge-template, https://github.com/gakonst/dapptools-template and https://github.com/transmissions11/dapptools-template