From ff42a16438f7083e79df953b13990a9d263665a1 Mon Sep 17 00:00:00 2001 From: Niko PLP Date: Tue, 29 Apr 2025 18:53:32 +0300 Subject: [PATCH] framework getting started --- src/pages/en/framework/getting-started.md | 12 +++++++++--- src/pages/en/framework/nuri.md | 14 +++++++------- 2 files changed, 16 insertions(+), 10 deletions(-) diff --git a/src/pages/en/framework/getting-started.md b/src/pages/en/framework/getting-started.md index 52aa7c6..e7427b4 100644 --- a/src/pages/en/framework/getting-started.md +++ b/src/pages/en/framework/getting-started.md @@ -4,11 +4,17 @@ description: How to use NextGraph framework to develop your decentralized App layout: ../../../layouts/MainLayout.astro --- -NextGraph Framework will be available soon. +We recently released an alpha version of the SDK for web applications. -Stay tuned! +You can try it and start developing a webapp that connects to the user's wallet and gets access to their data. As your app will be running on its own domain name, we call this "standalone" mode. -You can already read more about our framework and what it will offer, in the [following sections](/en/framework/data-first). +For now we support JS, TS, and React. Svelte will come soon. + +More details and a tutorial will come here in the coming days, in the meanwhile, you can see the [README of our npm package](https://www.npmjs.com/package/nextgraphweb). We also have created a [demo app in React](https://git.nextgraph.org/NextGraph/nextgraph-rs/src/branch/master/ng-sdk-js/example-webapp-react), that you can use as an example. + +If you want to test his demo app, it is available at [localfirstapp.eu](https://localfirstapp.eu) you will need to first create a wallet at [nextgraph.eu](https://nextgraph.eu). + +You can read more about our framework and what it does or will offer, in the [following sections](/en/framework/data-first). If you have questions or want to get in touch with us, the simplest way is to join the [forum](https://forum.nextgraph.org). diff --git a/src/pages/en/framework/nuri.md b/src/pages/en/framework/nuri.md index 2c8ffde..d81720a 100644 --- a/src/pages/en/framework/nuri.md +++ b/src/pages/en/framework/nuri.md @@ -46,8 +46,8 @@ We omit here the prefix did:ng as it is common to all the schemes. | fully qualified read-write Document Nuri | `:o:[repoid]:r:[readcap]:w:[overlayLink]:l:[peers]` | | document accessed by Token | `:o:[repoid]:n:[readtoken]:v:[overlayID]:l:[peers]` | | PermaCap | `:o:[repoid]:s:[permacap]:v:[overlayID]:l:[peers]` | -| specific commit | `:o:[repoid]:c:[commitid]:k:[commitkey]:h:[topicid]:v:[overlayID]:l:[peers]` | -| head with 2 commits | `:o:[repoid]:c:[commitid]:k:[commitkey]:c:[commitid]:k:[commitkey]:h:[topicid]:v:[overlayID]:l:[peers]` | +| specific commit | `:o:[repoid]:c:[commitid]:k:[commitkey]:y:[topicid]:v:[overlayID]:l:[peers]` | +| head with 2 commits | `:o:[repoid]:c:[commitid]:k:[commitkey]:c:[commitid]:k:[commitkey]:y:[topicid]:v:[overlayID]:l:[peers]` | | named commit or branch | `:o:[repoid]:a:[name]:r:[repo_readcap]:v:[overlayID]:l:[peers]` | | branchID | `:o:[repoid]:b:[branchId]:r:[branch_readcap]:v:[overlayID]:l:[peers] ` | | binary file | `:j:[objectid]:k:[key]:v:[overlayID]:l:[peers]` | @@ -72,11 +72,11 @@ When those capabilities are stored inside an RDF document, they are decomposed i | `:o:[repoid]:n:[readtoken]` | ` ` | | `:o:[repoid]:s:[permacap]` | ` ` | | `:o:[repoid]:c:[commitid]…` | ` ` | -| | ` ` | +| | ` ` | | `:o:[repoid]:a:[name]` | ` ` | | `:o:[repoid]:b:[branchid]` | ` ` | | | ` ` | -| `:j:[objectid]:k:[key]` | ` ` | +| `:j:[objectid]:k:[key]` | ` ` | | | ` ` | | if it is an attachment | ` ` | @@ -171,8 +171,8 @@ for all the above URIs that are stores, adding a trailing :r will restrict the g | Comments | :m | all the comments on the document | | BackLinks | :v | mentions, followers, inverse relationships, reactions received and backlinks | | Context | :x | contains the JSON-LD context (prefixes → link to ontologies) | -| Follower | :h | list of followers | -| Following | :y | list of following | +| Follower | ng:h | list of followers | +| Following | ng:y | list of following | ### Context and ontologies @@ -216,7 +216,7 @@ All the files of a branch (added with the AddFile commit) will be listed by the | ng:access | Nuri | did:ng:r:[readcap] | readcap of a branch, gives option to
subscribe to topic and retrieve
all the content (domain did:ng:o:b) | | | | did:ng:n:[readtoken] | same but without subscription possible | | | | did:ng:s:[permacap] | a permacap : a traditional capability (like z-caps) | -| | | did:ng:k:[key]:h:[topicid] | key and optional topicid of a commit | +| | | did:ng:k:[key]:y:[topicid] | key and optional topicid of a commit | | ng:revision | Nuri | did:ng:c:[]:c:[] | tells we are interested in a specific HEADS | | | | did:ng:a:[name] | idem with a specific named branch or commit | | | | did:ng:b:[branchid] | idem with a specific branch ID |