didcomm-demo
didcomm-demo copied to clipboard
decentralized-identity
In browser DIDComm v2 demo.
DIDComm Browser Demo
Overview
The DIDComm Browser Demo showcases a fully functioning DIDComm v2 application capable of both sending and receiving messages through a DIDComm v2 capable mediator. The primary goal of the demo is to simplify the understanding of DID Communication (DIDComm) principles by implementing only essential protocols.
Supported Protocols
Mediation Protocols:
Core Protocols:
Utility Protocols for Enhanced Usability:
DID Support:
Currently, only did:peer:2 DIDs are supported. Upon page load, a new did:peer:2 DID is generated, which connects to a mediator to negotiate mediation.
Getting Started
Prerequisites
Before you can run or build the DIDComm Browser Demo, ensure you have the following installed:
Installation
Clone the repository and install the dependencies:
git clone https://github.com/decentralized-identity/didcomm-demo.git
cd didcomm-demo
npm install # Or use yarn install if you prefer yarn over npm
Running the Application
To run the application locally:
npm start # Or yarn start
This command starts a local development server. Open http://localhost:8080 in your browser to view the application.
Building the Application
To build the application for production:
npm run build # Or yarn build
This will bundle the application into static files in the dist/ directory.
Formatting Code
To format the TypeScript files in the src/ directory:
npm run format # Or yarn format
Contributing
Contributions to the DIDComm Browser Demo are welcome! Here are a few ways you can help:
- Report issues and suggest features in the Issues section of the repository.
- Submit pull requests with bug fixes and new features.
Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.
License
This project is licensed under the MIT License - see the LICENSE file for details.
decentralized-identity