Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/unirep/create-unirep-app
A template for creating a UniRep attester.
https://github.com/unirep/create-unirep-app
Last synced: 5 days ago
JSON representation
A template for creating a UniRep attester.
- Host: GitHub
- URL: https://github.com/unirep/create-unirep-app
- Owner: Unirep
- Created: 2022-11-15T03:46:57.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-12T03:20:21.000Z (8 months ago)
- Last Synced: 2024-11-03T16:34:27.197Z (11 days ago)
- Language: TypeScript
- Homepage: https://demo.unirep.io
- Size: 16.3 MB
- Stars: 24
- Watchers: 5
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
create-unirep-app
This is a demo app of a [unirep](https://github.com/Unirep/Unirep) attester. In this demo app, users can request data from the example [attester](https://developer.unirep.io/docs/protocol/users-and-attesters). After transition, users can prove how much data they have.
Learn more about [how to build with create-unirep-app](https://developer.unirep.io/docs/getting-started/create-unirep-app)!
## 🔋 Requirements
- Node.js >=18
- To write custom circuits: install [rust](https://www.rust-lang.org/tools/install) and [circom 2](https://docs.circom.io/getting-started/installation/)
## 🛠 1. Installation
```shell
npx create-unirep-app
```
Then `cd` into the directory that was created.
## 📦 2. Local Development
### 2.1 Build the files
```shell
yarn build
```
> [!TIP]
> To overwrite circuit keys, delete `.wasm`, `.zkey` and `.vkey.json` objects in `packages/circuits/zksnarkBuild` and run:
>
> ```shell
> yarn circuits buildsnark
> ```
### 2.2 Start a node
```shell
yarn contracts hardhat node
```
### 2.3 Deploy smart contracts
in new terminal window, from root:
```shell
yarn contracts deploy
```
### 2.4 Start a relayer (backend)
```shell
yarn relay start
```
### 2.5 Start a frontend
in new terminal window, from root:
```shell
yarn frontend start
```
It will be running at: http://localhost:3000/
## 🎁 3. Linting
### 3.1 Format the code
```shell
yarn lint:fix
```
### 3.2 Check if the code is formatted
```shell
yarn lint:check
```
## 🛜 4. Deployment
### 4.1 Deploy smart contract
- Edit the `packages/contracts/.env` after `yarn build`.
- Get your `ETH_PROVIDER_URL` from [infura](https://www.infura.io/), [alchemy](https://alchemy.com/), or other provider services.
- Get your `PRIVATE_KEY` and paste it in `.env` starting with `0x`.
- Run
```sh
yarn contracts deploy --network custom
```
from root directory
### 4.2 Deploy the frontend
[Vercel](https://vercel.com/) is a Frontend Cloud. You can easily deploy the frontend and relay service with Vercel.
> [!CAUTION]
> It will be a serverless relay. Learn more about [serverless functions](https://vercel.com/docs/functions/serverless-functions).
- **Deploy serverless relay:**
- 
Click the `Deploy` button, and add the following settings
- Go to **Settings > Environment Variables**
set
| key | value |
|--|--|
| `PRIVATE_KEY` | 0x... |
| `ETH_PROVIDER_URL` |https://... |
| `APP_ADDRESS` | 0x... |
| `UNIREP_ADDRESS` | 0x... |
from `packages/relay/.env`
- Go to **Deployments**, choose the deployment and click ...
Click **Redeploy**
- Redeploy the relay, you will get a `https://{RELAY_APP_NAME}.vercel.app` as the relay server.
- View demo: https://create-unirep-app-relay.vercel.app/
- **Deploy frontend:**
- Go to vercel [dashboard](https://vercel.com/dashboard) and click **Add New... > Project**
- Choose the same repo as you created before.
- Set
**Framework Preset:** `Create React App`
**Build Command:** `yarn build`
**Output Directory:** `packages/frontend/build`
**Environment Variables:**
| key | value |
|--|--|
| `SERVER` |`https://{RELAY_APP_NAME}.vercel.app` |
and leave other settings as default.
- Deploy the frontend, you will get a `https://{FRONTEND_APP_NAME}.vercel.app` app!
- View demo: https://create-unirep-app-frontend.vercel.app/
## 🙌🏻 Join our community
- Discord server: 
- Twitter account: 
- Telegram group: 
## 
Privacy & Scaling Explorations
This project is supported by [Privacy & Scaling Explorations](https://pse.dev/) and the Ethereum Foundation.
See more projects on: https://pse.dev/projects.