Skip to content

Commit 337bc4d

Browse files
Merge pull request #968 from ProvableHQ/docs/sdk-doc-reorganization
[Documentation] Reorganization and Upgrade of SDK docs
2 parents 0282c70 + 730ce63 commit 337bc4d

File tree

121 files changed

+13855
-16298
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

121 files changed

+13855
-16298
lines changed

create-leo-app/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "create-leo-app",
3-
"version": "0.8.2",
3+
"version": "0.8.5",
44
"type": "module",
55
"license": "GPL-3.0",
66
"collaborators": [

create-leo-app/template-vanilla/main.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ document.querySelector("#app").innerHTML = `
3939
<div class="card">
4040
<button onclick="window.execute()">Call Execute Function</button>
4141
<button onclick="window.key()">Get Private Key</button>
42-
<button onclick="window.deploy()">Deploy HelloWorld Program</button>
42+
<button onclick="window.deploy()">Deploy Hello World Program</button>
4343
</div>
4444
<p class="read-the-docs">
4545
Click on the Aleo logo to learn more

docs/00_overview.md

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
id: overview
3+
title: SDK for Building Zero-Knowledge Web Apps
4+
sidebar_label: Overview
5+
---
6+
7+
<p align="center">
8+
<img alt="Provable SDK" width="1412" src="../.resources/banner.png">
9+
</p>
10+
11+
<p align="center">
12+
<a href="https://docs.leo-lang.org"> <img alt="Website" src="https://img.shields.io/badge/Developer_Docs-online-blue"></a>
13+
<a href="https://circleci.com/gh/ProvableHQ/sdk"><img src="https://circleci.com/gh/ProvableHQ/sdk.svg?style=svg"></a>
14+
<a href="https://discord.com/invite/aleo"><img src="https://img.shields.io/discord/700454073459015690?logo=discord"/></a>
15+
<a href="https://github.com/ProvableHQ/sdk#%EF%B8%8F-contributors"><img src="https://img.shields.io/badge/contributors-23-ee8449"/></a>
16+
<a href="https://www.npmjs.com/package/@provablehq/sdk"> <img alt="Provable SDK" src="https://img.shields.io/npm/l/%40provablehq%2Fsdk?label=NPM%20-%20Aleo%20SDK&labelColor=green&color=blue"></a>
17+
</p>
18+
19+
20+
The [Provable SDK](https://github.com/ProvableHQ/sdk) is an open source TypeScript/JavaScript SDK for building private full stack web applications. The
21+
SDK provides an easy API for using Aleo's core suite of cryptographic primitives, zk-SNARKs and private program execution
22+
protocol directly within Javascript. It also provides APIs for interacting with nodes and applications on the Aleo Network.
23+
24+
Applications built with the Provable SDK include:
25+
* **Private DeFi**
26+
* **Private Data Custody Systems**
27+
* **Zk Games & Gaming Toolkits**
28+
* **ZkML**
29+
* **Zero-Knowledge Identity Management**
30+
* **Aleo Wallets**
31+
32+
## Features
33+
The Provable SDK provides the following features. Follow the links below for live demonstrations of these features on
34+
[provable.tools](https://provable.tools)
35+
1. [Aleo account management](https://provable.tools/account)
36+
2. [Aleo cryptographic primitives](https://provable.tools/algebra)
37+
3. [Web based zero-knowledge program execution and deployment](https://provable.tools/develop)
38+
4. [Aleo credit transfers and staking](https://provable.tools/transfer)
39+
5. [Management of program state](https://provable.tools/protocol)
40+
6. [Communication with the Aleo network](https://provable.tools/rest)
41+
42+
43+
## Start Building
44+
45+
Developers interested in using the SDK to build private web applications can get started with the following resources.
46+
47+
### [The SDK Guide](https://docs.explorer.provable.com/docs/sdk/6p7047svvq2ox-intro-to-aleo)
48+
<a href="https://www.npmjs.com/package/@provablehq/sdk"> <img alt="Provable SDK" src="https://img.shields.io/npm/l/%40provablehq%2Fsdk?label=NPM%20-%20Aleo%20SDK&labelColor=green&color=blue"></a>
49+
50+
A step-by-step guide to building private web applications with the Provable SDK. The guide covers creating Aleo accounts,
51+
transferring and receiving aleo credits, executing/deploying/interacting with Aleo programs, managing private and public
52+
state, and best practices for building private web applications.
53+
54+
### [Create-Leo-App](https://docs.leo-lang.org/sdk/create-leo-app/tutorial)
55+
56+
<a href="https://www.npmjs.com/package/create-leo-app"> <img alt="Create Leo App" src="https://img.shields.io/npm/l/create-leo-app?label=NPM%20-%20Create-Leo-App&labelColor=green&color=blue"></a>
57+
58+
A suite of examples and templates for building private web applications in a variety of Javascript frameworks. These
59+
examples can be easily installed and run using the `create-leo-app` command line tool. The examples cover a wide range
60+
of use cases such as Private NFTs, offline transaction signing, and usage of the SDK in React, Next, and VanillaJS.
61+
62+
### [SDK API Documentation](https://docs.explorer.provable.com/docs/sdk/0qgi3uyhotv62-account)
63+
For developers who prefer to dive straight into the code, the SDK API documentation provides a comprehensive reference
64+
for all the SDK's classes, methods, and interfaces. The documentation is generated from the SDK's TypeScript source code.
65+
66+
### [Leo Language Documentation](https://docs.leo-lang.org)
67+
For developers who want to build their own zero-knowledge programs, the Leo Language provides an easy-to-use imperative
68+
programming language for writing zero-knowledge programs on Aleo. In conjuction with the SDK, private programs built
69+
using Leo can be turned into fully functional private web applications.
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading

0 commit comments

Comments
 (0)