JSPM

  • Created
  • Published
  • Downloads 322
  • Score
    100M100P100Q82036F

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (create-web3-dapp) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    Contributors Forks Stargazers Issues MIT License


    Logo

    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
    3. Roadmap
    4. Open Source
    5. Complementary Docs
    6. License
    7. Contributors

    About The Project

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

    product-screenshot

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

    create-web3-dapp is a 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 to 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
    1. The first time you run this command, it will install the package.

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

        npx create-web3-dapp
    1. Select the dependencies and components you want to include in your web3 application: product-screenshot-2

    2. Navigate to the application folder

    cd my-dapp
    1. Run the application
    npm run dev
    1. Go to to localhost:3000: product-screenshot

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


    Maintainers

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

    Check the contributions.md document to learn how to correctly contribute to create-web3-dapp and make sure to join our community on Discord to meet the other developers working on the project.

    (back to top)

    Complementary Docs

    • Core:
    • Web3:
    • Blockchain Development Environments:
    • CSS:

    (back to top)

    License

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

    (back to top)

    Contact

    @vittostack - vitto@alchemy.com

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

    (back to top)