/TheOrgBook

A public repository of verifiable claims about organizations. A key component of the Verifiable Organization Network.

Primary LanguagePythonApache License 2.0Apache-2.0

License

SonarQube Results:

Bugs Vulnerabilities Code smells Coverage Duplication Lines of code

Zap Results:

Bugs Vulnerabilities Code smells

TheOrgBook

TheOrgBook is a Credential Registry of verifiable credentials about entities. A public instance of TheOrgBook, such as BC's OrgBook contains a verifiable credentials about organizations (incorporations, professionals, etc.) issued by trusted public services such as Corporate Registries, regulatory agencies, permitting services, licencing services, procurement services and the like.

The Verifiable Organizations Network (VON) envisions the possibility of a number of public repositories of Verifiable Claims as a way of bootstrapping a trusted digital ecosystem.

TheOrgBook is being developed as part of the Verifiable Organizations Network (VON). For more information on VON see https://vonx.io. Even, better - join in with what we are doing and contribute to VON and the Indy community.

Quick Start Guide

The best way to get started with a new project is by working with a running instance. The VON Quick Start Guide will get you started with an Indy Network, an instance of TheOrgBook (this repo) and an instance of dFlow running on your local machine in Docker. Give it a try!

Running TheOrgBook on OpenShift

To deploy TheOrgBook on a local instance of OpenShift, refer to Running TheOrgBook Locally on OpenShift. These instructions, apart from the steps that are specific to setting up your local environment, can also be used to get the project deployed to a production OpenShift environment.

Running TheOrgBook on Docker

The project can also be run locally using Docker and Docker Compose. Refer to Running TheOrgBook with Docker Compose for instructions.

Resetting the Ledger

For information on the process of resetting the ledger and wallets refer to the Resetting the Ledger and Wallets documentation.