Skip to content
This repository has been archived by the owner on Jan 8, 2025. It is now read-only.

Commit

Permalink
add to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
oceans404 committed Feb 23, 2024
1 parent 1575c0c commit 96623f5
Showing 1 changed file with 26 additions and 18 deletions.
44 changes: 26 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# 🏗 Scaffold-ETH 2
# 🏗 Scaffold-ETH 2 with Nillion

<h4 align="center">
<a href="https://docs.scaffoldeth.io">Documentation</a> |
<a href="https://scaffoldeth.io">Website</a>
</h4>
This template has all the power of Scaffold-ETH 2 with a Nillion integration

🧪 An open-source, up-to-date toolkit for building decentralized applications (dapps) on the Ethereum blockchain. It's designed to make it easier for developers to create and deploy smart contracts and build user interfaces that interact with those contracts.
## About Scaffold-ETH 2

🧪 [Scaffold-ETH 2](https://docs.scaffoldeth.io) is an open-source, up-to-date toolkit for building decentralized applications (dapps) on the Ethereum blockchain. It's designed to make it easier for developers to create and deploy smart contracts and build user interfaces that interact with those contracts.

⚙️ Built using NextJS, RainbowKit, Hardhat, Wagmi, Viem, and Typescript.

Expand All @@ -25,18 +24,34 @@ Before you begin, you need to install the following tools:
- Yarn ([v1](https://classic.yarnpkg.com/en/docs/install/) or [v2+](https://yarnpkg.com/getting-started/install))
- [Git](https://git-scm.com/downloads)

Before using Nillion, you need to store your user key in MetaMask Snaps

1. Install the [MetaMask Flask browser extension](https://docs.metamask.io/snaps/get-started/install-flask/) that will let you work with experimental snaps

2. [Visit the Nillion Key Management UI](https://github.com/nillion-oss/nillion-snap) to generate a user key and store it in Snaps

3. Run through this quickstart and "Connect to Snap" from the UI

## Quickstart

To get started with Scaffold-ETH 2, follow the steps below:

1. Clone this repo & install dependencies

```
git clone https://github.com/scaffold-eth/scaffold-eth-2.git
cd scaffold-eth-2
git clone https://github.com/nillion-oss/scaffold-eth-with-nillion.git
cd scaffold-eth-with-nillion
yarn install
```

Download the [Nillion Javascript Client](https://docs.nillion.com/quickstart#download-binaries) to a local folder

Install the Nillion Javascript client as an additional dependency

```bash
yarn add {path-to-nillion-js-client-folder}
```

2. Run a local network in the first terminal:

```
Expand Down Expand Up @@ -67,14 +82,7 @@ Run smart contract test with `yarn hardhat:test`
- Edit your frontend in `packages/nextjs/pages`
- Edit your deployment scripts in `packages/hardhat/deploy`

## Documentation

Visit our [docs](https://docs.scaffoldeth.io) to learn how to start building with Scaffold-ETH 2.

To know more about its features, check out our [website](https://scaffoldeth.io).

## Contributing to Scaffold-ETH 2

We welcome contributions to Scaffold-ETH 2!
5. Connect to Nillion

Please see [CONTRIBUTING.MD](https://github.com/scaffold-eth/scaffold-eth-2/blob/main/CONTRIBUTING.md) for more information and guidelines for contributing to Scaffold-ETH 2.
- Visit the Nillion page on: `http://localhost:3000/nillion`
- Edit the Nillion page code in `packages/nextjs/app/nillion`

0 comments on commit 96623f5

Please sign in to comment.