nehal2210 / create-web3-dapp

The complete toolbox to create web3 applications

create-web3-dapp

Everything you need to build decentralized applications
Explore the docs »

Contribute · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Quickstart
3. Roadmap
4. Open Source
   • Contributors
   • Contributing
5. Complementary Docs
6. License
7. Contributors

About The Project

ATTENTION: This project is under beta and not ready for production - using it in product is highly discouraged without prior thorough review.

Create and deploy a decentralized application on Ethereum, Polygon, Solana, and all major chains, in a matter of minutes.

create-web3-dapp is an utility NPX package built on top of NextJS that allows developers to pick and choose the boilerplates of their decentralized application.

From the chain to use, through the wallet login system, to the React components to include and the Blockchain development environment, everything developers need to spin up their web3 dapps, bundled in an easy to use command line tool.

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• NodeJS

To install node go on the official Node website, and download the LTS package for your Operating System.

To verify if NodeJS has been correctly installed on your system, open your terminal and run:

node -v

and

npm -v

(back to top)

Quick Start

1. Create a new account on Alchemy.com

2. Create a new Alchemy application.

3. In your terminal run:

  npx create-web3-dapp

4. The first time you'll run this command, it will install the package.

5. Once installed, run the following command again - This will start the DApp creation flow.:

    npx create-web3-dapp

6. Select the dependencies and components you want to include in your web3 application:

7. Navigate to the application folder

cd my-dapp

8. Run the application

npm run dev

9. Go to to localhost:3000:

10. Enjoy Web3.

(back to top)

Roadmap

• Style localhost landing page + components
• Components selection workflow
• Write tests
• Implement support for new Blockchain development environments:
  • Foundry
  • Anchor
• Add OpenZeppelin Support
• Add collection floor price component
• Templates selection workflow
• Implement GitHub Actions build on push
• Review contributions .md

See the open issues for a full list of proposed features (and known issues).

(back to top)

Open Source

Contributors

• Vitto Rivabella - Linkedin - Twitter - GitHub
• Albert Hu - Linkedin - Twitter - GitHub

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Complementary Docs

• Core:
  • NextJS - docs
• Web3:
  • AlchemySDK - docs
  • EthersJS - docs
  • RainbowKit - docs
  • PhantomWallet - docs
• Blockchain Development Environments:
  • Hardhat - docs
  • Foundry - docs
  • Anchor - docs
• CSS:
  • Tailwind - docs
  • ChakraUI - docs

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @twitter_handle - [e-mail]

Project Link: https://github.com/eversmile12/create-web3-dapp

(back to top)