Boilerplate

Overview:

The repository consists of two components: a web app and contracts. The web app allows users to create a Semaphore identity, join a group, and send feedback anonymously on Arbitrum Goerli.

Features:

• Create Semaphore Identity: Users can create their own Semaphore identity.
• Join a Group: Users can join a group.
• Anonymous Feedback: Users can send their feedback anonymously on Arbitrum Goerli.

Installation:

To install and use the repository:

1. Use this repository as a Github template.
2. Clone your repository.
3. Install the dependencies.
4. Copy the .env.example file as .env and add your environment variables or run the app in a local network.
5. Start the app locally by running the command: yarn start
6. Deploy the contract by going to the apps/contracts directory and running the command: yarn deploy
7. Update your .env file with your new contract address, group id, and semaphore contract address.
8. Manually copy your contract artifacts from apps/contracts/build/contracts/contracts folder to apps/web-app/contract-artifacts folders or run yarn copy:contract-artifacts in the project root to do it automatically.
9. Run ESLint to analyze the code and catch bugs: yarn eslint
10. Run Prettier to check formatting rules: yarn prettier or to automatically format the code: yarn prettier --write

Summary:

The repository contains a web app and contracts that allow users to create a Semaphore identity, join groups, and send feedback anonymously on Arbitrum Goerli. The installation process involves cloning the repository, installing dependencies, deploying the contract, and configuring environment variables. Additionally, users can analyze the code and ensure code formatting using ESLint and Prettier tools.