Skip to content

Commit

Permalink
update reamdme with getting started instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
MattPereira committed Jan 19, 2024
1 parent 22cd8d7 commit 2757bcd
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 4 deletions.
34 changes: 30 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,38 @@
![OnlyBuidlors Thumbnail](https://only-buidlors.vercel.app/thumbnail.jpg)
![OnlyBuidlors Thumbnail](https://only-buidlors.vercel.app/readme-logo.jpgs)

A dynamic SVG NFT project that uses chainlink functions to fetch off chain data from the BuidlGuidl API. All BuidlGuidl members with at least 1 published build are welcome to mint an NFT with a dynamic background color that changes based on the number of builds submitted!

![NFT Example](https://only-buidlors.vercel.app/nft-example.jpg)
## Getting Started
### Run It Locally
1. Clone the repo
```bash
git clone https://github.com/MattPereira/only-buidlors
```

2. Install the packages with yarn
```
yarn install
```

3. Start the project on localhost
```
yarn start
```

### Create Chainlink Functions Subscription
The deployment script is setup to automatically add any freshly deployed contract to a chainlink functions subscription, but the subscription itself must be created at functions.chain.link

Make sure to change the subscriptionId for all the different networks in the `HelperConfig.s.sol`

Also need to change `SUBSCRIPTION_ID` on the frontend homepage `index.tsx`

### Deploying Contracts
```
yarn deploy --network arbitrumSepolia
```
*Foundry `HelperConfig.s.sol` script is also setup to support deployment to eth-sepolia and mumbai

### Getting Started

- TODO

### Technology Stack

Expand Down
Binary file added packages/nextjs/public/readme-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2757bcd

Please sign in to comment.