README
The Universe Eye: core implementation (JavaScript version)
Background
The Universe Eye is a protocol specification, implementation and SDK for building decentralized interoperable applications with full user data ownership and control.
Use the Universe Eye Open Source SDK to build interoperable decentralized applications which also have automated GDPR compliance.
The Universe Eye is built on a tree-like structure of data, enabling a seamless transfer of data between applications and platforms, this makes so applications can be merged, so your Inventory application can fuse together with your File sharing application, your Notes taking application, your Accounting application, etc.
Empower your users to apply their data to your application instead of having it locked-in.
There is no "mainnet" or similar, applications can work offline and datasets get merged when and if connecting together.
Data generated is stored in one or multiple sites, it depends on the user and the application. A site can be the users laptop, the application backend or a third party storage provider, etc.
Peers are connected together either in P2P, federation of peers or via centralized servers.
Data is controlled by the owner who issues receipts on the data, dictating how it can be used, how it can be shared and when it will be automatically deleted.
Current status
The protocol has reached a milestone where we have applications running on it, such as chat and filesync. We still anticipate some more time to increase security, add encryption at rest, etc.
Requirements
- Node.js v12
Recommended Yarn version 1.22.0 or later.
Development
yarn
This is the same as yarn install
.
Checks for known security issues with the involved packages. Checking for the integrity of files are expected to happen as part of the same process.
Please note that, for safety reasons, dependency scripts are disallowed from automatically executing as part of the install process. For dependencies in which there needs to happen a build, please manually invoke it so as necessary:
cd ./node_modules/<package_name>/
yarn run install
Check for updates
yarn outdated
Static analysis
yarn run eslint
yarn run jshint
Testing
yarn run test
Production
yarn install --production
References
- https://nodejs.org/docs/latest-v12.x/api/
- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference
- https://jsdoc.app/
- https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html
License
This project is released under the MIT license. Refer to the LICENSE file for details.