π Scaffold-ETH
everything you need to build on Ethereum! π
π§ͺ Quickly experiment with Solidity using a frontend that adapts to your smart contract:
πββοΈ Quick Start
Prerequisites: Node (v16 LTS) plus Yarn and Git
clone/fork π scaffold-eth:
git clone https://github.com/scaffold-eth/scaffold-eth.git
install and start your π·β Hardhat chain:
cd scaffold-eth
yarn install
yarn chain
in a second terminal window, start your π± frontend:
cd scaffold-eth
yarn start
in a third terminal window, π° deploy your contract:
cd scaffold-eth
yarn deploy
Deploying the Node.JS Server
You can deploy the server
as a Node.JS server using any cloud tool, such as Google App Engine.
Learn how to deploy by following this guide: https://cloud.google.com/appengine/docs/standard/nodejs/building-app
Mapping Metadata to Server Deployment
To have your NFTs show the art generated by the server, their image
and animation_url
fields need to point to the endpoint of that token ID.
For example, if you deployed your server to https://my-server.com/token/1
, your NFTs would have image
and animation_url
fields set to https://my-server.com/token/1
.
This way, when sites such as OpenSea attempt to render your NFTs, they will use the server to generate the art and display it.
IMPORTANT NOTE: This is a centralized method of generating art for your NFTs, if your server crashes or is unavailable, your NFTs will not show the art generated by the server until it is back up.
π Edit your smart contract YourContract.sol
in packages/hardhat/contracts
π Edit your frontend App.jsx
in packages/react-app/src
πΌ Edit your deployment scripts in packages/hardhat/deploy
π± Open http://localhost:3000 to see the app
π Documentation
Documentation, tutorials, challenges, and many more resources, visit: docs.scaffoldeth.io
π¦ Other Flavors
- scaffold-eth-typescript
- scaffold-eth-tailwind
- scaffold-nextjs
- scaffold-chakra
- eth-hooks
- eth-components
- scaffold-eth-expo
- scaffold-eth-truffle
π Learning Solidity
π Read the docs: https://docs.soliditylang.org
π Go through each topic from solidity by example editing YourContract.sol
in π scaffold-eth
π§ Learn the Solidity globals and units
π Buidl
Check out all the active branches, open issues, and join/fund the π° BuidlGuidl!
-
π« Extend the NFT example to make a "buyer mints" marketplace
-
βοΈ Learn how ecrecover works
-
π©βπ©βπ§βπ§ Build a multi-sig that uses off-chain signatures
-
βοΈ Learn how a simple DEX works
-
π¦ Ape into learning!
π P.S.
π You need an RPC key for testnets and production deployments, create an Alchemy account and replace the value of ALCHEMY_KEY = xxx
in packages/react-app/src/constants.js
with your new key.
π£ Make sure you update the InfuraID
before you go to production. Huge thanks to Infura for our special account that fields 7m req/day!
ππ¨ Speedrun Ethereum
Register as a builder here and start on some of the challenges and build a portfolio.
π¬ Support Chat
Join the telegram support chat π¬ to ask questions and find others building with π scaffold-eth!
π Please check out our Gitcoin grant too!