Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luloxi/0-to-buidlguidl
Onboarding dApp with free learning resources and a Dynamic SVG NFT | Built with Scaffold-eth 2 and daisyUI
https://github.com/luloxi/0-to-buidlguidl
Last synced: about 2 months ago
JSON representation
Onboarding dApp with free learning resources and a Dynamic SVG NFT | Built with Scaffold-eth 2 and daisyUI
- Host: GitHub
- URL: https://github.com/luloxi/0-to-buidlguidl
- Owner: luloxi
- License: mit
- Created: 2023-08-29T02:03:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-10T00:06:19.000Z (10 months ago)
- Last Synced: 2024-04-15T05:03:19.816Z (9 months ago)
- Language: TypeScript
- Homepage: https://0-to-buidlguidl.vercel.app
- Size: 1.8 MB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# 0 to BuidlGuidl
[**LIVE VERSION HERE**](https://0-to-buidlguidl.vercel.app/)
Onboarding dApp with:
- Roadmap to join [BuidlGuidl](https://buidlguidl.com/)
- Roadmap to get started building with [Scaffold-ETH 2](https://scaffoldeth.io/)
- QR share for live events
- Dynamic SVG NFT as a receipt after donating
## How can I contribute to this build?
- 🐣 Project being developed by [Newbie's Lounge](https://lulox.notion.site/Newbie-s-Lounge-68ea7c4c5f1a4ec29786be6a76516878)
- 👷♀️ To view current development tasks, [check the Issues on the Github repo](https://github.com/luloxi/0-to-BuidlGuidl/issues).
- 🧰 To chat with other buidlers about this project, [join Newbies Lounge Telegram group](https://t.me/+FwCZPG51UhwzOTZh)
- 🛠️ To submit a PR (Pull Request), [fork and pull](https://github.com/susam/gitpr) a request to this repo.
- 🐣 Make sure you know the ETH Tech Stack and understand [how to make a dApp using Scaffold-ETH 2](https://lulox.notion.site/Newbie-s-Lounge-68ea7c4c5f1a4ec29786be6a76516878).
Built using [Scaffold-ETH 2](https://scaffoldeth.io/) | NextJS, RainbowKit, Hardhat, Wagmi, Typescript, TailwindCSS and daisyUI
🧪 [Scaffold-ETH 2](https://scaffoldeth.io/) is an open-source, up-to-date toolkit for building decentralized applications (dapps) on the Ethereum blockchain. It's designed to make it easier for developers to create and deploy smart contracts and build user interfaces that interact with those contracts.
- v1 Smart contract is more gas efficient thanks to [Solady](https://github.com/Vectorized/solady/tree/main) <- Version currently deployed
- v2 contract is even more gas efficient thanks to [McToady's gas audit](https://github.com/McCoady/zero-to-bg-gas-audit/)
## Run this repo on your computer!
Before you begin, you need to install the following tools:
- [Node (v18 LTS)](https://nodejs.org/en/download/)
- Yarn ([v1](https://classic.yarnpkg.com/en/docs/install/) or [v2+](https://yarnpkg.com/getting-started/install))
- [Git](https://git-scm.com/downloads)
## Quickstart
To get this repo started on your local machine, follow the steps below:
1. Clone this repo & install dependencies
```
git clone https://github.com/luloxi/0-to-BuidlGuidl.git
cd 0-to-BuidlGuidl
yarn install
```
2. Run a local network in the first terminal:
```
yarn chain
```
This command starts a local Ethereum network using Hardhat. The network runs on your local machine and can be used for testing and development. You can customize the network configuration in `hardhat.config.ts`.
3. On a second terminal, deploy the test contract:
```
yarn deploy
```
This command deploys a test smart contract to the local network. The contract is located in `packages/hardhat/contracts` and can be modified to suit your needs. The `yarn deploy` command uses the deploy script located in `packages/hardhat/deploy` to deploy the contract to the network. You can also customize the deploy script.
4. On a third terminal, start your NextJS app:
```
yarn start
```
Visit your app on: `http://localhost:3000`. You can interact with your smart contract using the contract component or the example ui in the frontend. You can tweak the app config in `packages/nextjs/scaffold.config.ts`.
## Play with this repo!
- Run smart contract tests with `yarn hardhat:test`
- Edit your smart contract `ZeroToBuidlGuidlNFT.sol` in `packages/hardhat/contracts`
- Edit your deployment scripts in `packages/hardhat/deploy`
- Edit your frontend in `packages/nextjs/pages`
- Read [SE2-DOCUMENTATION](./SE2-DOCUMENTATION.md) to learn how this repo works!
## Development notes
You can check current development notes [here](https://lulox.notion.site/0-to-BuidlGuidl-4126ce65cc8d45158d6c3e1b2eebe28f?pvs=4)
Reference repos used for building this one:
- [BuidlGuidl Dynamic SVG NFT (BuidlGuidl Tabard)](https://app.buidlguidl.com/build/NxKk0AQM5LBm2ks4aSZr)
- [SE2-MoodNFT](https://app.buidlguidl.com/build/3zdTZJx6Au5qL6BDbdfc)
- [zero-to-bg-gas-audit](https://github.com/McCoady/zero-to-bg-gas-audit/)