Skip to content

Commit f05818c

Browse files
authored
Merge pull request #58 from datapartyjs/docs-updates
docs updates
2 parents 1b75472 + 7693f9e commit f05818c

112 files changed

Lines changed: 1437 additions & 431 deletions

File tree

Some content is hidden

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

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
/dist
2-
/docs
2+

README.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,36 +3,49 @@
33

44
decentralized cloud framework for the Web3.0 generation.
55

6-
Dataparty allows the app maker to decide how centralized or distributed they app should be and implement that vision rapidly.
7-
86
* Documentation - [datapartyjs.github.io/dataparty-api](https://datapartyjs.github.io/dataparty-api)
97
* NPM - [npmjs.com/package/@dataparty/api](https://www.npmjs.com/package/@dataparty/api)
108
* Code - [github.com/datapartyjs/dataparty-api](https://github.com/datapartyjs/dataparty-api)
119
* Support - [ko-fi/dataparty](https://ko-fi.com/dataparty)
1210

13-
## Goals
11+
## Design Goal
12+
13+
Dataparty services are able to run on servers, edge devices, or even directly in the browser or app. This means users of dataparty based apps can frequently run their own backend from within an app. By building this peer-to-peer functionality directly into the database ORM, `dataparty/api`, saves significant effort for app makers.
1414

15-
The primary goal of `@dataparty/api` is to enable secure microservices development across all architectual domains with a single code base. This covers traditional clouds, peer-to-peer apps(with or without cloud backing), and hybrid clouds. Dataparty services are able to be run on servers, edge devices, or even directly in the browser or app. This means users of dataparty based apps can frequently run their own backend from with an app.
15+
### Plugable
16+
For many domains the exact performance characteristics of the database, communications, and security matter a lot. All major systems are fairly pluggable so that additional drivers(db, comms etc) can be developed.
1617

1718

1819
## Features
1920

21+
![Feature Roadmap 2023](images/dataparty-overivew-full.svg)
22+
23+
2024
A dataparty app/service typically consists of these parts:
2125

2226
* [Comms](https://datapartyjs.github.io/dataparty-api/module-Comms.html)
27+
* We support everything from WebRTC, Websockets, HTTP to BLE and i2p/tor.
2328
* [Config](https://datapartyjs.github.io/dataparty-api/module-Config.html)
29+
* Persist configuration in a number of ways.
2430
* [Db](https://datapartyjs.github.io/dataparty-api/module-Db.html)
31+
* Select the database that makes sense for you, see [database selection](#database-selection)
2532
* [Party](https://datapartyjs.github.io/dataparty-api/module-Party.html)
33+
* The primary query interface. Abstracts the DBs into a common realtime-db interface. Partys can interact with local, remote and even peer-to-peer hosted DBs. Select the type of party that makes sense for you. See [party selection](#party-selection)
2634
* [Service](https://datapartyjs.github.io/dataparty-api/module-Service.html)
2735

2836

29-
## Roadmap
30-
31-
Currently this project is considered `Experimental`, throughout 2023 we'll be working towards our first stable releases.
37+
### Database Selection
3238

33-
![Feature Roadmap 2023](images/dataparty-overivew-full.svg)
3439

40+
Database | Browser | Cordova | Electron | Embedded Linux | Node
41+
-----|----|-|--|-|-
42+
[Lokijs](https://datapartyjs.github.io/dataparty-api/module-Db.LokiDb.html) | y | y | y | NR* | NR*
43+
[Zangodb](https://datapartyjs.github.io/dataparty-api/module-ZangoDb) | y | y | y | n | n
44+
[Tingo](https://datapartyjs.github.io/dataparty-api/module-TingoDb) | n | P* | y | y | y
45+
[Mongo](https://datapartyjs.github.io/dataparty-api/module-MongoDb) | n | P* | y | y | y
3546

47+
*NR - Not Recommended
48+
*P - Possibly. We're looking into it.
3649

3750
## Example
3851

docs/CloudDocument.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

docs/DocumentFactory.html

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/LokiParty.html

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)