Semaphore Boilerplate

The repository is divided into three components: web app, relay and contracts. The app allows users to create their own Semaphore identity and create events where only members can post reviews anonymously.

flowchart LR

A(Web App) -->|Create events| C(Contracts)
A -->|Join events| B(Relay)
A -->|Post event reviews| B
B --> C

Loading

🛠 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.

ℹ️ You can use the default ones to start the app in a local network.

Start the app

Run the following commands sequentially in three separate tabs of the terminal:

yarn start:contracts

yarn start:web-app

yarn start:relay

Code quality and formatting

Run ESLint to analyze the code and catch bugs:

yarn lint

Run Prettier to check formatting rules:

yarn prettier

or to automatically format the code:

yarn prettier:write