|
3 | 3 |
|
4 | 4 | decentralized cloud framework for the Web3.0 generation. |
5 | 5 |
|
6 | | -Dataparty allows the app maker to decide how centralized or distributed they app should be and implement that vision rapidly. |
7 | | - |
8 | 6 | * Documentation - [datapartyjs.github.io/dataparty-api](https://datapartyjs.github.io/dataparty-api) |
9 | 7 | * NPM - [npmjs.com/package/@dataparty/api](https://www.npmjs.com/package/@dataparty/api) |
10 | 8 | * Code - [github.com/datapartyjs/dataparty-api](https://github.com/datapartyjs/dataparty-api) |
11 | 9 | * Support - [ko-fi/dataparty](https://ko-fi.com/dataparty) |
12 | 10 |
|
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. |
14 | 14 |
|
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. |
16 | 17 |
|
17 | 18 |
|
18 | 19 | ## Features |
19 | 20 |
|
| 21 | + |
| 22 | + |
| 23 | + |
20 | 24 | A dataparty app/service typically consists of these parts: |
21 | 25 |
|
22 | 26 | * [Comms](https://datapartyjs.github.io/dataparty-api/module-Comms.html) |
| 27 | + * We support everything from WebRTC, Websockets, HTTP to BLE and i2p/tor. |
23 | 28 | * [Config](https://datapartyjs.github.io/dataparty-api/module-Config.html) |
| 29 | + * Persist configuration in a number of ways. |
24 | 30 | * [Db](https://datapartyjs.github.io/dataparty-api/module-Db.html) |
| 31 | + * Select the database that makes sense for you, see [database selection](#database-selection) |
25 | 32 | * [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) |
26 | 34 | * [Service](https://datapartyjs.github.io/dataparty-api/module-Service.html) |
27 | 35 |
|
28 | 36 |
|
29 | | -## Roadmap |
30 | | - |
31 | | -Currently this project is considered `Experimental`, throughout 2023 we'll be working towards our first stable releases. |
| 37 | +### Database Selection |
32 | 38 |
|
33 | | - |
34 | 39 |
|
| 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 |
35 | 46 |
|
| 47 | +*NR - Not Recommended |
| 48 | +*P - Possibly. We're looking into it. |
36 | 49 |
|
37 | 50 | ## Example |
38 | 51 |
|
|
0 commit comments