{"id":19502736,"url":"https://github.com/provablehq/workshop","last_synced_at":"2025-05-15T14:05:43.884Z","repository":{"id":59887404,"uuid":"537820278","full_name":"ProvableHQ/workshop","owner":"ProvableHQ","description":"📜 A Starter Guide to Build ZK Applications 📜","archived":false,"fork":false,"pushed_at":"2024-12-17T21:22:14.000Z","size":13247,"stargazers_count":337,"open_issues_count":28,"forks_count":269,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-04-07T20:07:36.970Z","etag":null,"topics":["aleo","tutorial","workshop","zero-knowledge","zksnarks"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ProvableHQ.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-09-17T13:41:18.000Z","updated_at":"2025-04-04T03:36:09.000Z","dependencies_parsed_at":"2023-01-28T13:02:34.007Z","dependency_job_id":"5948bbae-9347-4dba-9660-cc5e8034006a","html_url":"https://github.com/ProvableHQ/workshop","commit_stats":{"total_commits":121,"total_committers":11,"mean_commits":11.0,"dds":0.628099173553719,"last_synced_commit":"0cf76d39f4cac24ca5a85fb47c09c74364137c28"},"previous_names":["provablehq/workshop"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProvableHQ%2Fworkshop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProvableHQ%2Fworkshop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProvableHQ%2Fworkshop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProvableHQ%2Fworkshop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ProvableHQ","download_url":"https://codeload.github.com/ProvableHQ/workshop/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254355334,"owners_count":22057354,"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":["aleo","tutorial","workshop","zero-knowledge","zksnarks"],"created_at":"2024-11-10T22:17:59.865Z","updated_at":"2025-05-15T14:05:38.797Z","avatar_url":"https://github.com/ProvableHQ.png","language":"Shell","readme":"\u003c!-- \u003ch1 align=\"center\"\u003eAleo Workshop\u003c/h1\u003e --\u003e\n\u003cimg alt=\"workshop\" width=\"1412\" src=\"./.resources/readme.png\"\u003e\n\u003ch3 align=\"center\"\u003e📜 A starter guide to build applications on Aleo 📜\u003c/h3\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://twitter.com/AleoHQ\"\u003e\u003cimg src=\"https://img.shields.io/twitter/url/https/twitter.com/AleoHQ.svg?style=social\u0026label=Follow%20%40AleoHQ\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://aleo.org/discord\"\u003e\u003cimg src=\"https://img.shields.io/discord/700454073459015690?logo=discord\"/\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## Table of Contents\n- [Build Guide](#build-guide)\n    - [Prerequisites](#prerequisites)\n    - [Installation](#installation)\n- [IDE Support](#ide-support)\n    - [VSCode](#vscode-preferred)\n    - [Sublime Text](#sublime-text)\n    - [IntelliJ IDEA](#intellij-idea)\n- [Application Walkthroughs](#application-walkthroughs)\n    - [🏛️ Auction](#-auction) ([Source Code](./auction/))\n    - [🏦 Basic Bank](#-basic-bank) ([Source Code](./basic_bank/))\n    - [🛳️ Battleship](#-battleship) ([Source Code](./battleship/))\n    - [⭕ Tic-Tic-Toe](#-tic-tac-toe) ([Source Code](./tictactoe/))\n    - [🪙 Token](#-token) ([Source Code](./token))\n    - [🗳️ Vote](#-vote) ([Source Code](./vote/))\n\n## Build Guide\n\nThe following steps will install Aleo and Leo on your machine. This workshop is compatible on macOS, Linux, and Windows machines.\n\n### Prerequisites\n\nThis workshop requires the following prerequisites.\n\n- Install `git` with [bit.ly/start-git](https://bit.ly/start-git)\n- Install `Rust`with [bit.ly/start-rust](https://bit.ly/start-rust)\n\n### Installation\n\nTo install Aleo and Leo, run:\n```\n./install.sh\n```\n\n## IDE Support\n\nThis workshop requires one of the following IDEs.\n- [VSCode](https://bit.ly/start-vscode)\n- [Sublime Text](https://bit.ly/start-sublime)\n- [IntelliJ IDEA](https://bit.ly/start-intellij)\n\n### VSCode (Preferred)\n\nStart by installing `VSCode` with [bit.ly/start-vscode](https://bit.ly/start-vscode).\n\n#### Next, in VSCode, open the **VSCode Marketplace**, type **Leo** into the search bar, and proceed to install the Leo plugin.\n![Leo VSCode](./.resources/leo-vscode.png)\n\n### Sublime Text\n\n\u003cdetails\u003e\u003csummary\u003eInstallation Steps\u003c/summary\u003e\n\nStart by installing `Sublime Text` with [bit.ly/start-sublime](https://bit.ly/start-sublime).\n\n#### Next, in Sublime Text, install [Package Control](https://packagecontrol.io):\n- On Windows/Linux: `ctrl + shift + p`, type **Install Package Control**, and press **Enter**.\n- On macOS: `cmd + shift + p`, type **Install Package Control**, and press **Enter**.\n\n#### Next, in Sublime Text, install [LSP](https://packagecontrol.io/packages/LSP):\n- On Windows/Linux: `ctrl + shift + p`, select **Package Control: Install Package**, type **LSP**, and press **Enter**.\n- On macOS: `cmd + shift + p`, select **Package Control: Install Package**, type **LSP**, and press **Enter**.\n\n#### Lastly, in Sublime Text, install [LSP-leo](https://packagecontrol.io/packages/LSP-leo):\n- On Windows/Linux: `ctrl + shift + p`, select **Package Control: Install Package**, type **LSP-leo**, and press **Enter**.\n- On macOS: `cmd + shift + p`, select **Package Control: Install Package**, type **LSP-leo**, and press **Enter**.\n\n\u003c/details\u003e\n\n### IntelliJ IDEA\n\n\u003cdetails\u003e\u003csummary\u003eInstallation Steps\u003c/summary\u003e\n\nStart by installing `IntelliJ IDEA` with [bit.ly/start-intellij](https://bit.ly/start-intellij).\n\n#### Next, in IntelliJ IDEA, open the **IntelliJ Marketplace** and select `Plugins`:\n- On Windows/Linux: `ctrl + ,` and select `Plugins` on the left hand bar\n- On macOS: `cmd + ,` and select `Plugins` on the left hand bar\n\nLastly, type **Leo** into the search bar, and install the official Leo plugin.\n\n\u003c/details\u003e\n\n## Application Walkthroughs\n\nThis workshop walks through the following applications:\n- [auction](./auction/) - A first-price sealed-bid auction in Leo\n- [basic_bank](./basic_bank/) - A simple-interest yielding bank account in Leo\n- [battleship](./battleship/)- A two-player game of Battleship in Leo\n- [tictactoe](./tictactoe/) - A standard game of Tic-Tac-Toe in Leo\n- [token](./token) - A transparent \u0026 shielded custom token in Leo\n- [vote](./vote/) - A ballot voting example in Leo\n\n### 🏛️ Auction\n\nA first-price sealed-bid auction in Leo.\n\nTo see the auction example, run:\n```\ncd auction \u0026\u0026 ./run.sh\n```\n\n### 🏦 Basic Bank\n\nA simple-interest yielding bank account in Leo.\n\nTo see the basic bank example, run:\n```\ncd basic_bank \u0026\u0026 ./run.sh\n```\n\n### 🛳️ Battleship\n\nA two-player game of Battleship in Leo.\n\nTo see a game of Battleship between two players, run:\n```\ncd battleship \u0026\u0026 ./run.sh\n```\n\n### ⭕ Tic-Tac-Toe\n\nA standard game of Tic-Tac-Toe in Leo.\n\nTo see a game of Tic-Tac-Toe between two players, run:\n```\ncd tictactoe \u0026\u0026 ./run.sh\n```\n\n### 🪙 Token\n\nA transparent \u0026 shielded custom token in Leo.\n\nTo see an example of minting and transfering tokens, run:\n```\ncd token \u0026\u0026 ./run.sh\n```\n\n### 🗳️ Vote\n\nA ballot voting example in Leo.\n\nTo see an example of a ballot, run:\n```\ncd vote \u0026\u0026 ./run.sh\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprovablehq%2Fworkshop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprovablehq%2Fworkshop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprovablehq%2Fworkshop/lists"}