-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update the README with some links to the site
- Loading branch information
Showing
1 changed file
with
85 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,43 +1,101 @@ | ||
| # Didimo | ||
| <div align="center"> | ||
|
|
||
| Validate your credential issuer! | ||
| # DIDimo | ||
| ## Your Trustworthy Compliance Checker for Decentralized Identity Solutions | ||
|
|
||
| --- | ||
| <img src="https://repository-images.githubusercontent.com/731107747/afa784ae-ee9f-4101-8cc8-440b839303d8" width="1000"> | ||
| </div> | ||
| <br><br> | ||
|
|
||
| ## Setup | ||
| ## 📋 DIDimo Features | ||
|
|
||
| 1. `git submodule update --init --recursive` | ||
| DIDimo is a platform designed to ensure that credential issuers and verifiers within decentralized identity ecosystems are compliant with industry standards. Whether you're developing digital wallets, government identity projects, or decentralized apps, DIDimo offers: | ||
|
|
||
| ### Backend | ||
| - **Compliance Assessment**: Verify alignment with industry standards for secure and interoperable identity management. | ||
| - **Debugging Tools**: Real-time analysis and resolution of cryptographic protocol issues. | ||
| - **Interoperability Testing**: Ensure your services work seamlessly with other global systems. | ||
| - **Periodic Checks**: Schedule automated compliance checks to maintain ongoing compliance with evolving standards. | ||
|
|
||
| 1. `cd admin && go build` | ||
| DIDimo is more than just a tool – it's a platform designed to foster trust, security, and innovation in the world of decentralized identity. | ||
|
|
||
| ### Frontend | ||
| ## 🎯 Project Goals | ||
|
|
||
| 1. `cd webapp && pnpm i` | ||
| - **Promote Interoperability**: Facilitate the adoption of standardized identity solutions that work across various platforms and technologies. | ||
| - **Enhance Security**: Provide tools and resources that help developers create secure identity solutions, protecting user data and privacy. | ||
| - **Foster Trust**: Build a trustworthy ecosystem where credential issuers and verifiers can demonstrate their compliance with industry standards. | ||
| - **Support Innovation**: Encourage the development of cutting-edge identity solutions by providing essential tools for testing, debugging, and compliance checking. | ||
|
|
||
| --- | ||
| # 👉 [DOCUMENTATION](https://forkbombeu.github.io/didimo/) | ||
|
|
||
| ## Usage | ||
| Click the link above to dive into our comprehensive documentation, where you’ll find detailed information about how DIDimo works, how to get started, and how to make the most of its features. | ||
|
|
||
| ### Backend | ||
| <br> | ||
|
|
||
| ``` | ||
| cd admin | ||
| ./pb serve | ||
| ``` | ||
| <div id="toc"> | ||
|
|
||
| ### Frontend | ||
| ### 🚩 Table of Contents | ||
|
|
||
| ``` | ||
| cd webapp | ||
| cp .env.example .env | ||
| pnpm dev | ||
| ``` | ||
| - [🚑 Community & support](#-community--support) | ||
| - [😍 Acknowledgements](#-acknowledgements) | ||
| - [👤 Contributing](#-contributing) | ||
| - [💼 License](#-license) | ||
|
|
||
| ## Usage with docker compose | ||
| </div> | ||
|
|
||
| ``` | ||
| docker compose build | ||
| docker compose up | ||
| ``` | ||
| *** | ||
| ## 🚑 Community & support | ||
|
|
||
| **[📝 Documentation](https://forkbombeu.github.io/didimo/)** - Getting started and more. | ||
|
|
||
| **[🌱 Ecosystem](https://github.com/forkbombeu/didimo_plugins)** - Plugins, resources, and more. | ||
|
|
||
| **[🚩 Issues](../../issues)** - Bugs end errors you encounter using didimo. | ||
|
|
||
| **[💬 Discussions](../../discussions)** - Get help, ask questions, request features, and discuss. | ||
|
|
||
|
|
||
| **[🔝 back to top](#toc)** | ||
|
|
||
| *** | ||
| ## 😍 Acknowledgements | ||
|
|
||
| Copyleft 🄯 2024 by [The Forkbomb Company](https://www.forkbomb.solutions), Amsterdam | ||
|
|
||
| <img align="left" src="./images/logo-ngi-trustchain-positive-rgb-PNG.png" width="145"> | ||
|
|
||
| Supported by [NGI TRUSTCHAIN](https://trustchain.ngi.eu/), which is made possible with financial support from the European Commission's [Next Generation Internet](https://ngi.eu/) programme. | ||
|
|
||
| **[🔝 back to top](#toc)** | ||
|
|
||
| *** | ||
| ## 👤 Contributing | ||
|
|
||
| 1. 🔀 [FORK IT](../../fork) | ||
| 2. Create your feature branch `git checkout -b feature/branch` | ||
| 3. Commit your changes `git commit -am 'feat: New feature\ncloses #398'` | ||
| 4. Push to the branch `git push origin feature/branch` | ||
| 5. Create a new Pull Request `gh pr create -f` | ||
| 6. 🙏 Thank you | ||
|
|
||
|
|
||
| **[🔝 back to top](#toc)** | ||
|
|
||
| *** | ||
| ## 💼 License | ||
| DIDimo - Your Trustworthy Compliance Checker for Decentralized Identity Solutions | ||
| Copyleft 🄯 2024 Dyne.org foundation, Amsterdam | ||
|
|
||
| This program is free software: you can redistribute it and/or modify | ||
| it under the terms of the GNU Affero General Public License as | ||
| published by the Free Software Foundation, either version 3 of the | ||
| License, or (at your option) any later version. | ||
|
|
||
| This program is distributed in the hope that it will be useful, | ||
| but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| GNU Affero General Public License for more details. | ||
|
|
||
| You should have received a copy of the GNU Affero General Public License | ||
| along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
|
|
||
| **[🔝 back to top](#toc)** |