Skip to content

Commit

Permalink
change docs to suggest using forge template approach
Browse files Browse the repository at this point in the history
  • Loading branch information
djviau committed Sep 20, 2023
1 parent 7f6b46c commit 991bc56
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 7 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>' &&
Expand All @@ -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:
Expand All @@ -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
Expand Down
18 changes: 16 additions & 2 deletions shipyardDocs/exampleNFTTutorial/EnvironmentSetup.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,25 @@

## Basic dev environment setup

First, you'll need to install foundry and run `forge build` to install dependencies and compile the contracts.
First, you'll need to create a new directory and `cd` into it:
```
mkdir my-shipyard-based-project &&
cd my-shipyard-based-project
```

Install the `foundryup` up command and run it, which in turn installs forge, cast, anvil, and chisel:
```
curl -L https://foundry.paradigm.xyz | bash &&
foundryup &&
foundryup
```

Create a new Foundry project based on Shipyard, which also initializes a new git repository.
```
forge init --template projectopensea/shipyard
```

Run `forge build` to install depencencies and compile the contracts. This will also create an populate the `out` and `cache` directories at the top level of the project.
```
forge build
```

Expand Down

0 comments on commit 991bc56

Please sign in to comment.