-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
change docs to suggest using forge template approach
- Loading branch information
djviau
committed
Sep 20, 2023
1 parent
7f6b46c
commit 991bc56
Showing
2 changed files
with
28 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -48,10 +48,11 @@ To deploy an NFT contract to the Goerli testnet, fund an address with 0.25 Goerl | |
TODO: update this to do the template thing. And add a bit about staying up to date with the latest. | ||
|
||
``` | ||
git clone [email protected]:ProjectOpenSea/shipyard.git && | ||
cd shipyard && | ||
mkdir my-shipyard-based-project && | ||
cd my-shipyard-based-project && | ||
curl -L https://foundry.paradigm.xyz | bash && | ||
foundryup && | ||
forge init --template projectopensea/shipyard && | ||
forge build && | ||
export GOERLI_RPC='https://goerli.blockpi.network/v1/rpc/public && | ||
export ETHERSCAN_API_KEY='<your_key>' && | ||
|
@@ -65,10 +66,11 @@ forge create --rpc-url $GOERLI_RPC \ | |
|
||
A quick breakdown of each step follows. | ||
|
||
Clone the `shipyard` repository and change directories into it: | ||
Create a directory, `cd` into it, : | ||
``` | ||
git clone [email protected]:ProjectOpenSea/shipyard.git && | ||
cd shipyard | ||
mkdir my-shipyard-based-project && | ||
cd my-shipyard-based-project && | ||
curl -L https://foundry.paradigm.xyz | bash | ||
``` | ||
|
||
Install the `foundryup` up command and run it, which in turn installs forge, cast, anvil, and chisel: | ||
|
@@ -77,6 +79,11 @@ curl -L https://foundry.paradigm.xyz | bash && | |
foundryup | ||
``` | ||
|
||
Create a new Foundry project based on Shipyard, which also initializes a new git repository. | ||
``` | ||
forge init --template projectopensea/shipyard | ||
``` | ||
|
||
Install dependencies and compile the contracts: | ||
``` | ||
forge build | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters