{"id":19712139,"url":"https://github.com/semaphore-protocol/boilerplate","last_synced_at":"2025-04-05T13:05:18.163Z","repository":{"id":38394672,"uuid":"457806962","full_name":"semaphore-protocol/boilerplate","owner":"semaphore-protocol","description":"Simple monorepo you can use as a template to start developing your dApp with Semaphore.","archived":false,"fork":false,"pushed_at":"2025-01-30T15:48:36.000Z","size":11866,"stargazers_count":89,"open_issues_count":0,"forks_count":35,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-29T12:04:26.174Z","etag":null,"topics":["boilerplate","hardhat","nextjs","semaphore"],"latest_commit_sha":null,"homepage":"https://demo.semaphore.pse.dev/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/semaphore-protocol.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-10T14:11:06.000Z","updated_at":"2025-02-06T17:13:49.000Z","dependencies_parsed_at":"2024-04-02T11:46:21.247Z","dependency_job_id":"1917a662-b86d-4873-ac96-c256053658ec","html_url":"https://github.com/semaphore-protocol/boilerplate","commit_stats":null,"previous_names":[],"tags_count":2,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/semaphore-protocol%2Fboilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/semaphore-protocol%2Fboilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/semaphore-protocol%2Fboilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/semaphore-protocol%2Fboilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/semaphore-protocol","download_url":"https://codeload.github.com/semaphore-protocol/boilerplate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247339155,"owners_count":20923014,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["boilerplate","hardhat","nextjs","semaphore"],"created_at":"2024-11-11T22:15:16.658Z","updated_at":"2025-04-05T13:05:18.113Z","avatar_url":"https://github.com/semaphore-protocol.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n    Semaphore Boilerplate\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/semaphore-protocol\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/project-Semaphore-blue.svg?style=flat-square\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/semaphore-protocol/boilerplate/blob/main/LICENSE\"\u003e\n        \u003cimg alt=\"Github license\" src=\"https://img.shields.io/github/license/semaphore-protocol/boilerplate.svg?style=flat-square\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/semaphore-protocol/boilerplate/actions?query=workflow%3Astyle\"\u003e\n        \u003cimg alt=\"GitHub Workflow style\" src=\"https://img.shields.io/github/actions/workflow/status/semaphore-protocol/boilerplate/style.yml?branch=main\u0026label=style\u0026style=flat-square\u0026logo=github\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://eslint.org/\"\u003e\n        \u003cimg alt=\"Linter eslint\" src=\"https://img.shields.io/badge/linter-eslint-8080f2?style=flat-square\u0026logo=eslint\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://prettier.io/\"\u003e\n        \u003cimg alt=\"Code style prettier\" src=\"https://img.shields.io/badge/code%20style-prettier-f8bc45?style=flat-square\u0026logo=prettier\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://www.gitpoap.io/gh/semaphore-protocol/boilerplate\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://public-api.gitpoap.io/v1/repo/semaphore-protocol/boilerplate/badge\"\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n| The repository is divided into two components: [web app](./apps/web-app) and [contracts](./apps/contracts). The app allows users to create their own Semaphore identity, join a group and then send their feedback anonymously (currently on Sepolia). |\n| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n\n## 🛠 Install\n\nUse this repository as a Github [template](https://github.com/semaphore-protocol/boilerplate/generate).\n\nClone your repository:\n\n```bash\ngit clone https://github.com/\u003cyour-username\u003e/\u003cyour-repo\u003e.git\n```\n\nand install the dependencies:\n\n```bash\ncd \u003cyour-repo\u003e \u0026\u0026 yarn\n```\n\n## 📜 Usage\n\nCopy the `.env.example` file as `.env`:\n\n```bash\ncp .env.example .env\n```\n\nand add your environment variables or run the app in a local network.\n\n### Local server\n\nYou can start your app locally with:\n\n```bash\nyarn dev\n```\n\n### Deploy the contract\n\n1. Go to the `apps/contracts` directory and deploy your contract:\n\n```bash\nyarn deploy --semaphore \u003csemaphore-address\u003e --network sepolia\n```\n\n2. Update the `apps/web-app/.env.production` file with your new contract address and the group id.\n\n3. Copy your contract artifacts from `apps/contracts/artifacts/contracts` folder to `apps/web-app/contract-artifacts` folder.\n\n\u003e [!NOTE]\n\u003e Check the Semaphore contract addresses [here](https://docs.semaphore.pse.dev/deployed-contracts).\n\n### Verify the contract\n\nVerify your contract on Etherscan:\n\n```bash\nyarn verify \u003cyour-contract-address\u003e \u003csemaphore-address\u003e --network sepolia\n```\n\n\u003e **Note**  \n\u003e Remember to set the Etherscan API Key in your .env file.\n\n### Code formatting\n\nRun [Prettier](https://prettier.io/) to check formatting rules:\n\n```bash\nyarn prettier\n```\n\nor to automatically format the code:\n\n```bash\nyarn prettier:write\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsemaphore-protocol%2Fboilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsemaphore-protocol%2Fboilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsemaphore-protocol%2Fboilerplate/lists"}