Rust implementation of NextGraph, a Decentralized and local-first web 3.0 ecosystem
https://nextgraph.org
byzantine-fault-tolerancecrdtsdappsdecentralizede2eeeventual-consistencyjson-ldlocal-firstmarkdownocapoffline-firstp2pp2p-networkprivacy-protectionrdfrich-text-editorself-hostedsemantic-websparqlweb3collaboration
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
86 lines
3.1 KiB
86 lines
3.1 KiB
# JS SDK of NextGraph
|
|
|
|
## NextGraph
|
|
|
|
> NextGraph brings about the convergence of P2P and Semantic Web technologies, towards a decentralized, secure and privacy-preserving cloud, based on CRDTs.
|
|
>
|
|
> This open source ecosystem provides solutions for end-users (a platform) and software developers (a framework), wishing to use or create **decentralized** apps featuring: **live collaboration** on rich-text documents, peer to peer communication with **end-to-end encryption**, offline-first, **local-first**, portable and interoperable data, total ownership of data and software, security and privacy. Centered on repositories containing **semantic data** (RDF), **rich text**, and structured data formats like **JSON**, synced between peers belonging to permissioned groups of users, it offers strong eventual consistency, thanks to the use of **CRDTs**. Documents can be linked together, signed, shared securely, queried using the **SPARQL** language and organized into sites and containers.
|
|
>
|
|
> More info here [https://nextgraph.org](https://nextgraph.org)
|
|
|
|
## WASM module
|
|
|
|
The [lib-wasm](../lib-wasm/README.md) crate contains the WASM module.
|
|
|
|
## Examples
|
|
|
|
- an example of web app using the vite bundler `example-webapp-vite`
|
|
- an example of React web app `app-react`
|
|
- an example of node-js app `app-node`
|
|
- `index.html` an example of vanilla JS usage of the SDK
|
|
|
|
## Support
|
|
|
|
Documentation can be found here [https://docs.nextgraph.org](https://docs.nextgraph.org)
|
|
|
|
And our community forum where you can ask questions is here [https://forum.nextgraph.org](https://forum.nextgraph.org)
|
|
|
|
## For developers
|
|
|
|
Read our [getting started guide](https://docs.nextgraph.org/en/getting-started/).
|
|
|
|
```
|
|
// for nodejs
|
|
npm i nextgraph
|
|
// or for browser
|
|
npm i @ng-org/web
|
|
```
|
|
|
|
## Publishing to npm
|
|
|
|
```
|
|
cargo run-script node
|
|
cd pkg-node
|
|
npm login --auth-type legacy
|
|
npm publish --auth-type legacy
|
|
```
|
|
|
|
### Example Plain JS web app (with Vite)
|
|
|
|
see [README here](example-webapp-vite/README.md)
|
|
|
|
### Example React web app
|
|
|
|
```
|
|
cd ../app-react
|
|
npm run dev
|
|
```
|
|
|
|
This URL will open automatically in browser : [http://localhost:8080](http://localhost:8080)
|
|
|
|
### Example NodeJS app
|
|
|
|
```
|
|
cd ../app-node
|
|
npm run start
|
|
```
|
|
|
|
### Contributions license
|
|
|
|
Unless you explicitly state otherwise, any contribution intentionally submitted
|
|
for inclusion in the work by you shall be dual licensed as below, without any
|
|
additional terms or conditions.
|
|
|
|
## License
|
|
|
|
Licensed under either of
|
|
|
|
- Apache License, Version 2.0 ([LICENSE-APACHE2](LICENSE-APACHE2) or http://www.apache.org/licenses/LICENSE-2.0)
|
|
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
|
|
at your option.
|
|
|
|
`SPDX-License-Identifier: Apache-2.0 OR MIT`
|
|
|
|
---
|
|
|
|
NextGraph received funding through the [NGI Assure Fund](https://nlnet.nl/assure) and the [NGI Zero Commons Fund](https://nlnet.nl/commonsfund/), both funds established by [NLnet](https://nlnet.nl/) Foundation with financial support from the European Commission's [Next Generation Internet](https://ngi.eu/) programme, under the aegis of DG Communications Networks, Content and Technology under grant agreements No 957073 and No 101092990, respectively.
|
|
|