-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #11 from moonshotcollective/updated-readme
Updated Readme
- Loading branch information
Showing
1 changed file
with
32 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |