NextGraph
/
docs-site
1
0
Fork 1
Code Issues Pull Requests Packages Projects Releases Wiki Activity

framework getting started

Browse Source
master
Niko PLP 21 hours ago
parent 644f41bbd5
commit ff42a16438
2 changed files with 16 additions and 10 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 12
      src/pages/en/framework/getting-started.md
  2. 14
      src/pages/en/framework/nuri.md

12
src/pages/en/framework/getting-started.md
Unescape View File

@ -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).

14
src/pages/en/framework/nuri.md
Unescape View File

@ -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]` | `<did:ng:o:[repoid]> <ng:access> <did:ng:n:[readtoken]>` |
| `:o:[repoid]:s:[permacap]` | `<did:ng:o:[repoid]> <ng:access> <did:ng:s:[permacap]>` |
| `:o:[repoid]:c:[commitid]…` | `<did:ng:o:[repoid]> <ng:revision> <did:ng:c:[]:c:[]>` |
| | `<did:ng:c:[commitid]> <ng:access> <k:[key]:h:[topicid]>` |
| | `<did:ng:c:[commitid]> <ng:access> <k:[key]:y:[topicid]>` |
| `:o:[repoid]:a:[name]` | `<did:ng:o:[repoid]> <ng:revision> <did:ng:a:[name]>` |
| `:o:[repoid]:b:[branchid]` | `<did:ng:o:[repoid]> <ng:revision> <did:ng:b:[branchid]>` |
| | `<did:ng:b:[branchid]> <ng:access> <did:ng:r:[branch_readcap]>` |
| `:j:[objectid]:k:[key]` | `<did:ng:j:[objectid]> <ng:access> <did:ng:k:[key]:h:[topic]>` |
| `:j:[objectid]:k:[key]` | `<did:ng:j:[objectid]> <ng:access> <did:ng:k:[key]:y:[topic]>` |
| | `<did:ng:j:[objectid]> <ng:overlay> <did:ng:v:[overlayid]>` |
| if it is an attachment | `<did:ng:o:[repoid]> <ng:attachment> <did:ng:j:[objectid]>` |
@ -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 <br/>subscribe to topic and retrieve<br/> 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 |

Write Preview
Loading…
Cancel
Save