dotAlgo-DID

Decentralized identity using Soulbound tokens (non-tranferrable tokens) on the Algorand blockchain, with IPFS metadata storage.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

ARC

Read the ARC here

About The Project

dotAglo-DID is a human-readable domain creator linked to a Soulbound non-transferable Identity token. The goal is to allow users to self identify and have their identity linked to the NFT. Users can then use the Soulbound token to identify or authenticate themselves in other dapps.

The NFT's are stored in the user wallet and linked to a human readable domain which can be used for resolution.

Here's why:

• Simple to remember, on the go.
• Linked wallet Soulbound token.
• One call address resolution and identity resolution.

(back to top)

Built With

• Algorand JAVA SDK
• JAVA
• Web3Storage
• Angular
• Algorand Sandbox
• IntelliJ Community
• Postman
• Maven

(back to top)

Notice

1. This project is not audited and should not be used in a production environment.
2. The project was build on Windows and has not been tested on any Linux distro, but it should run since the tools used are cross platform.

Getting Started

Follow the steps below on how to run the project.

Prerequisites

Please install the below required software in order to run the project.

• Algorand Sandbox Sandbox

• Java 11 Java

• Angular

  npm install -g @angular/cli

• Maven Maven

Installation

1. Clone the repo

   git clone https://github.com/IKalonji/DotAlgo.git

2. Run the Algorand Sandbox in testnet

   ./sandbox up testnet

3. Open the za.co.dotalgo server build and run. (KEEP THE SERVER RUNNING)

   run with IntelliJ

4. Run the Angular client to interact with the backend.

   cd dot-algo-demo-frontend
   ng serve --open

5. Start creating or importing test account and create your dotAlgo readable addresses, remember to fund test addresses.

(back to top)

Usage

Endpoints

Create account Create Soulbound asset (NFT) Resolve domain name

ADDITIONAL ENDPOINTS WILL BE PROVIDED FOR ALPHA RELEASE

Video Demo

Please refer to the Documentation

(back to top)

Roadmap

• Add multiple Algorand account support
• Deploy to mainnet

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Issa Kalonji - @ISSDawg - [email protected]

Project Link: https://github.com/IKalonji/DotAlgo

(back to top)

Acknowledgments

• Algorand
• Gitcoin
• Web3Storage

(back to top)