Skip to content

Commit

Permalink
feat(docs): add Protocol docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AGDholo committed Jun 14, 2023
1 parent 86f2f91 commit 60200f5
Showing 1 changed file with 42 additions and 1 deletion.
43 changes: 42 additions & 1 deletion darc-docs/docs/DARC Protocol/Getting Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,45 @@ sidebar_position: 1

# Getting Started

## What is the DARC Protocol?
## What is the DARC Protocol?

## Building the source

Since Hardhat and OpenZeppelin are used, the project can be built using the following commands:

1. Install dependencies

We recommend that you use `pnpm` instead of `npm`, but `npm` can also work.

`pnpm` is a newer package manager that has some advantages over npm. It is faster, more efficient, and disk-space
friendly.

```shell
cd darc-protocal
npm install
```

2. Compile the contracts

```shell
npx hardhat compile
```

3. Run the Darc test network

```shell
npm run node
```

4. Test contracts

```shell
npx hardhat test
REPORT_GAS=true npm run test
```

5. Deploy contracts

```shell
npm run deploy
```

0 comments on commit 60200f5

Please sign in to comment.