From 4a684b9c4945a381d5dd07eb9fb75bb24f1ef9ca Mon Sep 17 00:00:00 2001 From: Jhoemar Pagao Date: Fri, 24 Dec 2021 05:02:40 +0000 Subject: [PATCH] updated readme --- README.md | 42 +++++++++++++++++++++++++++++++++++++++--- 1 file changed, 39 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ad9d4c2..d34d724 100755 --- a/README.md +++ b/README.md @@ -1,8 +1,44 @@ # elabox-system-tools -Tools to manage different parts of Elabox +Elabox runtime. Provides system that handles communication and execution of dapps. ## VS CODE DEBUGGER SETTING This necessary capturing ide related conditions. foundation.system.IDE constant is true if currently debugging inside ide. -- Open laun.json -- add buildflags property to launch configuration if not yet existed "buildFlags": "-tags=IDE" \ No newline at end of file +- Open launch.json +- add buildflags property to launch configuration if not yet existed "buildFlags": "-tags=IDE" + +## Building from Source +- Configure for building +``` +cd ./internal/scripts +./setup.sh +``` + +- Building +``` +cd ./internal/scripts +./build.sh + +``` + +## Consepts +An operating system designed with holistic approach and security in mind powered by blockchains. +Features: + - Decentralized Identity(DID) - access to the system and its data are protected by your identity. + - Smart Contract + - Dapp Store - install and publish 3rd party dapps via dapp store + +Dapp Architecture +- a Dapp can talk to each other, broadcast and listen to any events +and handle background tasks. This is made possible via json RPC on the top of socket. +- Apps are being managed and handled by AppMan( Application Manager). +- a dapp should be defined on info.json +- a dapp compose of 3 main components. + +Service - a component that runs on background and provides services that can be consumed by other dapps. + +Activity - a component that would only run when started by user or another dapp. Usually this component contain UI to handle user operations. + +Broadcast Listener - a component that would only executes after an event was triggered. Analogy +Sample Broadcast listener +