[Circom Project Template]

Light and Easy to use template for Circom projects with the "easy build flow"

What do I need to have before I start?

To run the project, you need:

Circom 2 - For writing and compiling the circuits
Node.js & Yarn - For Writing tests and running the "easy build flow"
Bash Shell
- If you're on Linux or Mac OS, skip this, you probably already have it.
- If you're on Windows, use WSL

Before running any command, first:

Navigate to the project root
Run yarn to install the dependencies
yarn build - The Easy Build flow (Compiles, fetches trusted ceremony and creates a ZKP proof for the project)

For more control, the build command is broken down into several atomic components, where each can be ran by an individual command

Command	Description
`yarn compile`	Compiles the circuits and creates wasm binaries
`yarn ptau:fetch`	Fetches the Powers of Tau ceremony automatically
`yarn ptau:phase2`	Contributes to the Powers of Tau ceremony to be used for the project circuit
`yarn witness:generate`	Generate a witness using the inputs and the project circuit
`yarn proof:generate`	Create a Zero-Knowledge proof using the inputs

Tests are written in Typescript and done using the Mocha framework.

To run the tests, use yarn test