-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Readme update #186
base: main
Are you sure you want to change the base?
Readme update #186
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tysm Rinat 🙌
Since this will be shown on npm readme. I think its important to highlight npx create-eth@latest
command and also probably three magic commands make sense? Probably remove SE-2 repo reference from contributing stuff as well? Also remove under development line?
Maybe we have it like this?
🏗 create-eth
CLI to create decentralized applications (dapps) using Scaffold-ETH 2.
SE-2 Documentation | SE-2 Website
Requirements
Before you begin, you need to install the following tools:
- Node (>= v18.18)
- Yarn (v1 or v2+)
- Git
Quickstart
To get started with Scaffold-ETH 2, follow the steps below:
- Install the latest version of Scaffold-ETH 2
npx create-eth@latest
This command will install all the necessary packages and dependencies, so it might take a while.
Note
You can also initialize your project with one of our extensions to add specific features or starter-kits. Learn more in our extensions documentation.
- Run a local network in the first terminal:
yarn chain
This command starts a local Ethereum network that runs on your local machine and can be used for testing and development. Learn how to customize your network configuration.
- On a second terminal, deploy the test contract:
yarn deploy
This command deploys a test smart contract to the local network. You can find more information about how to customize your contract and deployment script in our documentation.
- 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 Debug Contracts
page. You can tweak the app config in packages/nextjs/scaffold.config.ts
.
Documentation
Visit our docs to learn all the technical details and guides of Scaffold-ETH 2.
To know more about its features, check out our website.
Contributing
I'm not sure about this part (55% not to add it/ 45% to add), because third-party extensions part looks too specific for such a short readme. But I'm very open to change it
Ohh yes yes let's not add that part
From the issue I thought we don't need requirements and yarn chain/deploy etc but this
makes sense Updated Readme as you suggested Thanks Shiv! |
> If you find any bug, please report as [issue](https://github.com/scaffold-eth/create-eth/issues) or send a message in [🏗 scaffold-eth developers chat](https://t.me/joinchat/F7nCRK3kI93PoCOk) | ||
|
||
# 🏗 create-eth | ||
## 🏗 create-eth |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we can keep the h1?
## 🏗 create-eth | |
# 🏗 create-eth |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice job @rin-st and @technophile-04 !! Only added a nitpick.
Even I really love how simple the readme looks like now, I have a couple of questions to discuss:
- Do you think we should add some kind of next steps (maybe could be simplified to a 1 liner to the website section) like we have in SE-2 Readme above documentation section
- Have realized we don't have any reference to BuidlGuidl or any social link. Do you think could be interesting to add a Community section, that could have some of these links:
- Link to scaffold-eth developers tg chat
- Link to twitter for project updates (maybe bg + se twitter)
- Youtube channel for guides / examples, maybe link to playlists
- Built by buidlguidl? With link to the website
Docs website have all these community links in the footer, but was wondering if it would be handy to have (some of?) them here too. Also the fact that the repo is inside scaffold-eth makes me feel a reference to BuidlGuidl would be nice here.
But just throwing the ideas as they came to my mind, totally fine to ignore and keep it simple 🙏
Second part from #99 :
requirements
andquickstart
blocksdocumentation
block togetting started
and added link to QuickStart Guide so it replaced bothrequirements
andquickstart
blocksAlso:
git clone
info from main descriptionFirst part from #99:
I'm not sure about this part (55% not to add it/ 45% to add), because third-party extensions part looks too specific for such a short readme. But I'm very open to change it
Fixes #99