Skip to content

Commit

Permalink
Merge pull request #11 from moonshotcollective/updated-readme
Browse files Browse the repository at this point in the history
Updated Readme
  • Loading branch information
farque65 authored Oct 20, 2021
2 parents b48f2d0 + 3d55eed commit a4dfc71
Showing 1 changed file with 32 additions and 11 deletions.
43 changes: 32 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,36 @@
# Basic Sample Hardhat Project
# Moonswap

This project demonstrates a basic Hardhat use case. It comes with a sample contract, a test for that contract, a sample script that deploys that contract, and an example of a task implementation, which simply lists the available accounts.
Prerequisites: [Node](https://nodejs.org/en/download/) plus [Yarn](https://classic.yarnpkg.com/en/docs/install/) and [Git](https://git-scm.com/downloads)

Try running some of the following tasks:
> clone/fork Moonswap:
```shell
npx hardhat accounts
npx hardhat compile
npx hardhat clean
npx hardhat test
npx hardhat node
node scripts/sample-script.js
npx hardhat help
```bash
git clone https://github.com/moonshotcollective/moonswap.git app
```

> install and start your 👷‍ Hardhat chain:
```bash
cd app
yarn install
yarn chain
```

> in a second terminal window, start your 📱 frontend:
```bash
cd app
yarn start
```

> in a third terminal window, 🛰 deploy your contract:
```bash
cd app
yarn deploy
```


# 📚 Documentation

Documentation, tutorials, challenges, and many more resources, visit: [docs.scaffoldeth.io](https://docs.scaffoldeth.io)

0 comments on commit a4dfc71

Please sign in to comment.