Giter VIP home page Giter VIP logo

create-ether-dapp's Introduction

๐Ÿ”ฅ Create Ether Dapp License: MIT PRs Welcome

๐Ÿ› ๏ธ An Ethereum template to help you get building ASAP with all the necessary tools you'll actually use!

โ›“๏ธ This template allows you to build Full-Stack Blockchain Applications.

๐Ÿ’ฅ All the sections below utilize the power of TypeScript.

giphy

Technologies Used

๐ŸŽจ Front-end: Next.js (React), Tailwind CSS, Ethers.js, MetaMask, IPFS, Pinata

๐Ÿ‘ทโ€โ™‚๏ธ Smart Contracts: Hardhat, Ethers.js, TypeChain, OpenZeppelin, Mocha, Chai, Waffle

๐Ÿ—ƒ๏ธ Back-end: Node.js, MongoDB, Mongoose, Express, Ethers.js, Joi

How to Use

NOTE: Required a UNIX terminal like Windows WSL, Bash, ZSH, Fish, Shell, etc.

1. First Method (Recommended)

Using the script will create a new project at my-dapp in the current working directory.

yarn create ether-dapp my-dapp
cd my-dapp
yarn dev

It's required that you have yarn installed. If you don't, simply run npm i -g yarn. Using yarn create ether-dapp ensures that you always use the latest version.

Once the app is running using yarn dev you can view at:

2. Second Method

To use this template, all you have to do is select "Use this template" from within the main GitHub repository of this project. This will allow you to create a brand new repo using this template as a starting base.

After creating a new repo by using this one as a template, clone your new repo into your IDE of choice. Once cloned, go into your new cloned repo & run:

yarn install

You can also cd into all 3 directories (frontend, backend, & hardhat) & run yarn install.

Running All at the Same Time

You can run the backend, frontend, and local blockchain node all from 1 single terminal instance. To do so, run the following command from your project's root directory.

yarn dev

This utilizes a package called concurrently that allows you to concurrently run all instances from a single terminal.

Special Thanks

This project was insipired by:

Issues

If you find any issues, please report them in the Issues.

Also, if you see something that could be improved, feel free to contribute!

If for some reason you are getting an error during the installation, try running:

yarn global remove create-ether-dapp
yarn create ether-dapp my-dapp

Make sure to Star!๐ŸŒŸ

create-ether-dapp's People

Contributors

awfuldarkness0110 avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.