Skip to content
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

Adapt readme and contributing guide to create-eth repo #26

Merged
merged 3 commits into from
May 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# Welcome to Scaffold-ETH 2 Contributing Guide
# Welcome to create-eth Contributing Guide
carletex marked this conversation as resolved.
Show resolved Hide resolved

Thank you for investing your time in contributing to Scaffold-ETH 2!
Thank you for investing your time in contributing to create-eth!

This guide aims to provide an overview of the contribution workflow to help us make the contribution process effective for everyone involved.

## About the Project

Scaffold-ETH 2 is CLI tool to create a minimal repo providing builders with a starter kit to build decentralized applications on Ethereum.
create-eth is a CLI tool to create a minimal repo to build decentralized applications on Ethereum, providing builders with a starter kit based on Scaffold-ETH 2.

Read the [README](README.md) to get an overview of the project.

### Vision

The goal of Scaffold-ETH 2 is to provide the primary building blocks for a decentralized application.
The goal of create-eth is to be a "toolkit creator", using Scaffold-ETH 2 as a base to provide the primary building blocks for a decentralized application. In the future we plan to add "curated" packages to it, and open the possibility to import 3rd party packages (that follow our standard).

The repo can be forked to include integrations and more features.

Expand Down Expand Up @@ -44,7 +44,7 @@ Issues should be used to report problems, request a new feature, or discuss pote

#### Solve an issue

Scan through our [existing issues](https://github.com/scaffold-eth/scaffold-eth-2/issues) to find one that interests you.
Scan through our [existing issues](https://github.com/scaffold-eth/create-eth/issues) to find one that interests you.

If a contributor is working on the issue, they will be assigned to the individual. If you find an issue to work on, you are welcome to assign it to yourself and open a PR with a fix for it.

Expand All @@ -66,12 +66,16 @@ We follow the ["fork-and-pull" Git workflow](https://github.com/susam/gitpr)

1. Fork the repo
2. Clone the project
3. Create a new branch with a descriptive name
3. Create a new branch (based in create-eth main branch) with a descriptive name
4. Commit your changes to the new branch
5. Add [changeset](#changeset) if applicable
6. Push changes to your fork
7. Open a PR in our repository and tag one of the maintainers to review your PR

> ⚠️ **Important.** Please make sure to choose **create-eth** repo when you create your branch and compare your changes.
>
> This repo is a fork of Scaffold-ETH 2, and it may appear as default repo when creating a branch or PR.

Here are some tips for a high-quality pull request:

- Create a title for the PR that accurately defines the work done.
Expand Down
37 changes: 17 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,18 @@
> ⚠️ The [CLI branch](https://github.com/scaffold-eth/scaffold-eth-2/tree/cli) is under active development.
> If you find any bug, please report as [issue](https://github.com/scaffold-eth/scaffold-eth-2/issues) or send a message in [🏗 scaffold-eth developers chat](https://t.me/joinchat/F7nCRK3kI93PoCOk)
> ⚠️ Under active development.
>
> 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)

# 🏗 Scaffold-ETH 2
# 🏗 create-eth

<h4 align="center">
<a href="https://docs.scaffoldeth.io">Documentation</a> |
<a href="https://scaffoldeth.io">Website</a>
</h4>

🧪 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.

⚙️ Built using NextJS, RainbowKit, Hardhat, Wagmi, Viem, and Typescript.
CLI to create decentralized applications (dapps) using Scaffold-ETH 2.
carletex marked this conversation as resolved.
Show resolved Hide resolved

- ✅ **Contract Hot Reload**: Your frontend auto-adapts to your smart contract as you edit it.
- 🪝 **[Custom hooks](https://docs.scaffoldeth.io/hooks/)**: Collection of React hooks wrapper around [wagmi](https://wagmi.sh/) to simplify interactions with smart contracts with typescript autocompletion.
- 🧱 [**Components**](https://docs.scaffoldeth.io/components/): Collection of common web3 components to quickly build your frontend.
- 🔥 **Burner Wallet & Local Faucet**: Quickly test your application with a burner wallet and local faucet.
- 🔐 **Integration with Wallet Providers**: Connect to different wallet providers and interact with the Ethereum network.
This is an alternative method of installing Scaffold-ETH. Instead of directly [cloning SE-2](https://docs.scaffoldeth.io/quick-start/installation#option-1-setup-using-git-clone), you can use create-eth to create your own custom instance, where you can choose among several configurations and extensions.

![Debug Contracts tab](https://github.com/scaffold-eth/scaffold-eth-2/assets/55535804/b237af0c-5027-4849-a5c1-2e31495cccb1)
<h4 align="center">
<a href="https://github.com/scaffold-eth/scaffold-eth-2">SE-2 Repo</a> |
<a href="https://docs.scaffoldeth.io">SE-2 Docs</a> |
<a href="https://scaffoldeth.io">SE-2 Website</a>
</h4>

## Requirements

Expand Down Expand Up @@ -90,8 +84,11 @@ Visit our [docs](https://docs.scaffoldeth.io) to learn how to start building wit

To know more about its features, check out our [website](https://scaffoldeth.io).

## Contributing to Scaffold-ETH 2
## Contributing to create-eth

We welcome contributions to create-eth and Scaffold-ETH 2!

We welcome contributions to Scaffold-ETH 2!
For more information and guidelines for contributing, please see:

Please see [CONTRIBUTING.MD](https://github.com/scaffold-eth/scaffold-eth-2/blob/main/CONTRIBUTING.md) for more information and guidelines for contributing to Scaffold-ETH 2.
- [create-eth CONTRIBUTING.MD](https://github.com/scaffold-eth/create-eth/blob/main/CONTRIBUTING.md) if you want to contribute to the CLI.
- [Scaffold-ETH 2 CONTRIBUTING.MD](https://github.com/scaffold-eth/scaffold-eth-2/blob/main/CONTRIBUTING.md) if you want to contribute to SE-2 base code.