README.md

Semaphore Boilerplate

The repository is divided into two components: web app and contracts. The app allows users to create their own Semaphore identity, join a group and then send their feedback anonymously (currently on Sepolia).

🛠 Install

Use this repository as a Github template.

Clone your repository:

git clone https://github.com/<your-username>/<your-repo>.git

and install the dependencies:

cd <your-repo> && yarn

📜 Usage

Copy the .env.example file as .env:

cp .env.example .env

and add your environment variables or run the app in a local network.

Local server

You can start your app locally with:

yarn dev

Deploy the contract

1. Go to the apps/contracts directory and deploy your contract:

yarn deploy --semaphore <semaphore-address> --network sepolia

2. Update the apps/web-app/.env.production file with your new contract address and the group id.

3. Copy your contract artifacts from apps/contracts/artifacts/contracts folder to apps/web-app/contract-artifacts folder.

Note

Check the Semaphore contract addresses here.

Verify the contract

Verify your contract on Etherscan:

yarn verify <your-contract-address> <semaphore-address> --network sepolia

Note
Remember to set the Etherscan API Key in your .env file.

Code formatting

Run Prettier to check formatting rules:

yarn prettier

or to automatically format the code:

yarn prettier:write