diff --git a/bun.lockb b/bun.lockb new file mode 100755 index 0000000..b60c48a Binary files /dev/null and b/bun.lockb differ diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index db99ef2..283d087 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -19,36 +19,40 @@ export default defineConfig({ sidebar: [ { text: "🚀 Getting started", - link: "/getting-started" + link: "/getting-started", }, { - text: "Core technologies", + text: "🏗️ Core Technologies", + link: "/core-technologies", items: [ - { text: "Zenroom", link: "#zenroom" }, - { text: "Slangroom", link: "#slangroom" }, - { text: "No-code-room", link: "#no-code-room" }, + { text: "Zenroom", link: "/core-technologies#%F0%9F%94%90-zenroom" }, + { text: "Slangroom", link: "/core-technologies#📜-slangroom" }, + { text: "No-code-room", link: "/core-technologies#%F0%9F%9B%A0%EF%B8%8F-no-code-room-ncr" }, { text: "Dyne.org Decentralized Identifiers (DID) Service", - link: "#dyneorg-decentralized-identifiers-did-service", + link: "/core-technologies#%F0%9F%94%97-dyne-org-decentralized-identifiers-did-service", }, ], }, { - text: "Components", + text: "💡 The solution", + link: "/solution", items: [ - { - text: "DiDRoom control room / Dashboard", - link: "#didroom-control-room-dashboard", - }, - { text: "Didroom microservices", link: "#didroom-microservices" }, - { text: "Wallet holder app", link: "#wallet-holder-app" }, - { text: "Verifier app", link: "#verifier-app" }, + { text: "Mobile Zencode", link: "/solution#mobile-zencode" }, + { text: "DiDRoom control room / Dashboard", link: "/solution#didroom-control-room-dashboard", }, + { text: "Didroom microservices", link: "/solution#didroom-microservices" }, + { text: "Wallet holder app", link: "/solution#wallet-holder-app" }, + { text: "Verifier app", link: "/solution#verifier-app" }, + { text: "Didroom web components", link: "/solution#didroom-web-components" }, ], }, { text: "Deployment options", items: [ - { text: "Software as a Service (SaaS)", link: "#software-as-a-service-saas", }, + { + text: "Software as a Service (SaaS)", + link: "#software-as-a-service-saas", + }, { text: "On-Premise deployment", link: "#on-premise-deployment" }, ], }, diff --git a/docs/core-technologies.md b/docs/core-technologies.md new file mode 100644 index 0000000..346f977 --- /dev/null +++ b/docs/core-technologies.md @@ -0,0 +1,23 @@ +# 🏗️ Core Technologies + +## 🔐 Zenroom + Zenroom is responsible for all underlying cryptographic operations within the DiDRoom ecosystem. It provides a secure execution environment for cryptographic operations and smart contracts, ensuring privacy, security, and integrity in digital interactions. Notably, Zenroom runs isomorphically on the web, mobile, and servers across various platforms in a deterministic way. + - [Documentation](https://dev.zenroom.org/) + - [GitHub](https://github.com/dyne/zenroom) + - [Site](https://zenroom.org/) + +## 📜 Slangroom + Slangroom enhances the Zencode language of Zenroom by allowing the addition of plugins. These plugins extend the functionality of Zencode by enabling actions that do not necessarily need to be performed within virtual machines. Slangroom's approach is super standard, making it easy to add custom functionalities within the Zencode natural language. Additionally, Slangroom is capable of running over web pages using WebAssembly. + - [Documentation](https://dyne.org/slangroom) + - [GitHub](https://github.com/syne/slangroom) + +## 🛠️ No-code-room (NCR) + No-code-room is a Single Executable Application (SEA) for Linux. It takes a filesystem with .zen (Zencode/Slangroom) contracts and creates API microservices using live-directory routing. NCR seamlessly generates REST services that are auto-documented with OpenAPI. Additionally, it creates small graphic interfaces on the fly, referred to as applets. + - [GitHub](https://github.com/forkbombeu/ncr) + +## 🔗 Dyne.org Decentralized Identifiers (DID) Service + In 2022, Dyne.org implemented a W3C-DID method approved by the W3C governing board and included in the official DID method list. The DID service supports federation and provides tools for the creation, resolution, and management of decentralized identifiers (DIDs). It includes support for ECDSA, EDDSA, Schnorr, Ethereum address, as well as a Dilithium quantum-proof public key. + - [GitHub](https://github.com/dyne/w3c-did) + - [Online DIDs Explorer](https://explorer.did.dyne.org/) + - [Specification](https://dyne.org/W3C-DID/) + - [Site](https://forkbomb.solutions/component/w3c-did-federate-service/) diff --git a/docs/dashboard.md b/docs/dashboard.md new file mode 100644 index 0000000..e95b5be --- /dev/null +++ b/docs/dashboard.md @@ -0,0 +1,26 @@ +## Quickstart + +```shell +git clone --recursive https://github.com/forkbombeu/signroom +docker compose up + +``` + +The user name and pass are: + +head your browser to `http://localhost:8090/_` + +::: warning +Pay attention at the underscore as the `path` for the admin section +::: + + +::: tip +default username and password are: + +`admin@example.org` +`adminadmin` +::: + + +## Configuration \ No newline at end of file diff --git a/docs/solution.md b/docs/solution.md new file mode 100644 index 0000000..d5d1d41 --- /dev/null +++ b/docs/solution.md @@ -0,0 +1,34 @@ +# 💡 The Solution +Our solution is divided into different repositories, each focusing on a specific component. This modular approach allows us to maintain flexibility and scalability, enabling users to customize and integrate the solution according to their specific needs and requirements. + +## Mobile Zencode + Zencode Mobile holds all the business logic and contracts shared between the different components of the DiDRoom Solution. It serves as a centralized repository for managing and updating the core business logic used across various mobile applications and components. + - [GitHub](https://github.com/forkbombeu/mobile_zencode) + +## DiDRoom control room / Dashboard + The Didroom Control Room/Dashboard serves as the central hub for managing decentralized identity solutions. It provides a user-friendly interface for configuring settings, monitoring performance, and accessing key functionalities. + - [GitHub](https://github.com/forkbombeu/signroom) + - [Public beta](https://beta.signroom.io) + +## Didroom microservices + Didroom microservices are generated using No-code-room (NCR) and utilize the Zencode Mobile repository to create three different microservices: + - **Credential Issuers**: These microservices are compliant with Openid4VCI standards and handle the issuance of credentials. + - **Authorization Server**: These microservices implement OAuth2 and work seamlessly with our DID Service for authentication and authorization. + - **Relying Party**: These microservices are compliant with Openid4VP standards and act as relying parties for authentication and authorization. + - [GitHub](https://github.com/forkbombeu/didroom_microservices) + + +## Wallet Holder App + The Wallet Holder App offers a secure and user-friendly interface for managing decentralized identities and digital credentials. It allows users to store, view, and share their identity information with ease inside a TEE (Trusted execution environment) directly on citizens devices. + - [GitHub](https://github.com/forkbombeu/wallet) + - [Latest relase](https://github.com/ForkbombEu/wallet/releases/latest/download/wallet.apk) + +## Verifier App + The Verifier App provides tools for verifying the authenticity and validity of decentralized identities and digital credentials. It enables organizations to validate identity claims and ensure compliance with regulatory requirements. + - [GitHub](https://github.com/forkbombeu/verifier) + - [Latest relase](https://github.com/ForkbombEu/verifier/releases/latest/download/wallet.apk) + +## Didroom web components + DiDRoom Web Components hold all the UI web components used across all the projects to ensure a coherent Atomic design and allow for white-labeling. + - [Storybook](https://forkbombeu.github.io/didroom-components) + - [GitHub](https://github.com/forkbombeu/didroom-components) \ No newline at end of file