https://github.com/refcell/huffplate
Robust, Extensible Template for Huff Projects
https://github.com/refcell/huffplate
evm foundry huff solidity
Last synced: 5 months ago
JSON representation
Robust, Extensible Template for Huff Projects
- Host: GitHub
- URL: https://github.com/refcell/huffplate
- Owner: refcell
- License: mit
- Created: 2022-09-15T17:40:06.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-25T01:00:21.000Z (almost 3 years ago)
- Last Synced: 2025-05-05T15:54:40.427Z (5 months ago)
- Topics: evm, foundry, huff, solidity
- Language: Solidity
- Homepage:
- Size: 1.38 MB
- Stars: 27
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# huffplate • [](https://github.com/abigger87/huffplate/actions/workflows/ci.yaml)   
A **Robust**, **Extensible** Template for Huff Projects
> **Warning**
>
> These contracts are **unaudited** and are not recommended for use in production.
>
> Although contracts have been rigorously reviewed, this is **experimental software** and is provided on an "as is" and "as available" basis.
> We **do not give any warranties** and **will not be liable for any loss** incurred through any use of this codebase.
### Getting Started
Click [`use this template`](https://github.com/abigger87/huffplate/generate) to create a new repository with this repo as the initial state.
Or, if your repo already exists, run:
```sh
forge init --template https://github.com/abigger87/huffplate
git submodule update --init --recursive
forge install
```
### Blueprint
```txt
lib
├─ forge-std — https://github.com/foundry-rs/forge-std
├─ solmate — https://github.com/Rari-Capital/solmate
scripts
├─ Deploy.s.sol — Simple Deployment Script
src
├─ SimpleStore.sol — A Minimal Storage Contract
test
└─ SimpleStore.t.sol — SimpleStore Tests
```
### Development
Install dependencies, compile your contracts, and test all with [Foundry](https://github.com/foundry-rs/foundry)!
```bash
forge install
forge build
forge test
```
#### First time with Forge/Foundry?
See the official Foundry installation [instructions](https://github.com/foundry-rs/foundry/blob/master/README.md#installation).
Then, install the [foundry](https://github.com/foundry-rs/foundry) toolchain installer (`foundryup`) with:
```bash
curl -L https://foundry.paradigm.xyz | bash
```
Now that you've installed the `foundryup` binary,
anytime you need to get the latest `forge` or `cast` binaries,
you can run `foundryup`.
So, simply execute:
```bash
foundryup
```
🎉 Foundry is installed! 🎉
#### Configure Foundry
Using [foundry.toml](./foundry.toml), Foundry is easily configurable.
For a full list of configuration options, see the Foundry [configuration documentation](https://github.com/foundry-rs/foundry/blob/master/config/README.md#all-options).
### Acknowledgements
- [femplate](https://github.com/abigger87/femplate)
- [foundry](https://github.com/foundry-rs/foundry)
- [solmate](https://github.com/Rari-Capital/solmate)
- [forge-std](https://github.com/brockelmore/forge-std)
- [forge-template](https://github.com/foundry-rs/forge-template)
- [foundry-toolchain](https://github.com/foundry-rs/foundry-toolchain)