ZK-Groups

👥 Contributing   |   🤝 Code of conduct   |   🔎 Issues   |   🗣️ Chat & Support

Semaphore provides a set of JavaScript libraries to create identities, groups, generate zero-knowledge proofs and verify them with minimal effort.

🛠 Install

Clone this repository:

git clone https://github.com/semaphore-protocol/zk-groups.git

and install the dependencies:

cd zk-groups && yarn

📜 Usage

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

Conventional commits

Semaphore uses conventional commits. A command line utility to commit using the correct syntax can be used by running:

yarn commit

It will also automatically check that the modified files comply with ESLint and Prettier rules.

Testing

Run Jest to test the code with coverage:

yarn test:all

yarn test <app-name> # For specific apps

Build packages

Run Webpack to build the applications:

yarn build:all

yarn build <app-name> # For specific apps

A dist folder will be created.