Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
EvgenKor committed Apr 10, 2022
1 parent 0053ca2 commit 09e6a35
Show file tree
Hide file tree
Showing 3 changed files with 8,885 additions and 9,413 deletions.
37 changes: 32 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,36 @@
# ZeroPool Web Console

The simple tool to test and demonstrate zkBob solution possibilities

# Running locally
1. `git clone --recurse-submodules https://github.com/zeropoolnetwork/zeropool-console.git`
2. `./scripts/build-deps` - to build parameters and contracts
3. `./scripts/start-node` - start a hardhat node
4. `./scripts/start-local` - start the console dev server

The local hardhat test node is configured with this seed phrase: `crazy appear raise time fashion kind pattern crazy device split escape wolf`.
Make sure you are using node js version higher or equal than `14.0.0`. The repo has been tested with `node v16.14.1` and `npm v8.5.0`

1. Clone repository and install dependencies

```bash
git clone https://github.com/zkBob/zeropool-console.git
cd zeropool-console
yarn install
```

2. Set appropriated settings in the `.env` file

3. Put circuit parameters and keys in `asset` folder. The same files should be located on relayer node

4. Run local bundle
```
yarn dev
```
5. Open your browser and enter [http://localhost:3000/](http://localhost:3000/) in the address line

It's recommended to clear your browser's history and cookies in case of you was used previous version of console

# Creating Docker container

Suppose you already done local running and set appropriated parameters and settings

1. Fix your docker ID in [this line](https://github.com/zkBob/zeropool-console/blob/0053ca2a63d00fd4be4e9bd646c05ffbdc2ecf3e/scripts/publish-docker#L4)

2. Build the prouction pack and push your container to the Docker Hub: `./scripts/publish-docker`

2 changes: 1 addition & 1 deletion scripts/publish-docker
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/usr/bin/env bash

yarn build:prod && \
docker buildx build -f Dockerfile.prod --push -t voidxnull/zeropool-console .
docker buildx build -f Dockerfile.prod --push -t evgenkor/zeropool-console .
Loading

0 comments on commit 09e6a35

Please sign in to comment.