{"id":20037413,"url":"https://github.com/animo/animo-demo","last_synced_at":"2025-05-05T06:30:51.544Z","repository":{"id":37044269,"uuid":"444823409","full_name":"animo/animo-demo","owner":"animo","description":"Interactive demo explaining the concepts of self-sovereign identity.","archived":false,"fork":false,"pushed_at":"2023-06-07T17:57:45.000Z","size":5195,"stargazers_count":31,"open_issues_count":25,"forks_count":49,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-08T18:40:25.863Z","etag":null,"topics":["hacktoberfest","identity","self","sovereign","typescript"],"latest_commit_sha":null,"homepage":"https://demo.animo.id","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/animo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-01-05T13:57:42.000Z","updated_at":"2025-01-09T12:27:16.000Z","dependencies_parsed_at":"2024-11-13T10:30:21.650Z","dependency_job_id":null,"html_url":"https://github.com/animo/animo-demo","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/animo%2Fanimo-demo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/animo%2Fanimo-demo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/animo%2Fanimo-demo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/animo%2Fanimo-demo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/animo","download_url":"https://codeload.github.com/animo/animo-demo/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252451380,"owners_count":21749927,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","identity","self","sovereign","typescript"],"created_at":"2024-11-13T10:19:25.293Z","updated_at":"2025-05-05T06:30:50.515Z","avatar_url":"https://github.com/animo.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cbr /\u003e\n\u003cimg src=\"https://i.imgur.com/m6bVqCY.png\" alt=\"screenshot-demo\" height=\"600px\"/\u003e\n\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003e\u003cb\u003eAnimo Self-Sovereign Identity Demo\u003c/b\u003e\u003c/h1\u003e\n\u003cdiv align=\"center\"\u003e\n  \n[![Continuous Deployment](https://github.com/animo/animo-demo/actions/workflows/continuous-deployment.yml/badge.svg)](https://github.com/animo/animo-demo/actions/workflows/continuous-deployment.yml)\n    \u003ca\n    href=\"https://raw.githubusercontent.com/hyperledger/aries-framework-javascript/main/LICENSE\"\n    \u003e\u003cimg\n      alt=\"License\"\n      src=\"https://img.shields.io/badge/License-Apache%202.0-blue.svg\"\n  /\u003e\u003c/a\u003e\n  [![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)\n \n\u003c/div\u003e\n\n## ✨ Hi there!\n\nWelcome to the repository of Animo's Self-Sovereign identity demo. This interactive app demonstrates the use of verifiable credentials. This demo is built using [Aries Framework Javascript (AFJ)](https://github.com/hyperledger/aries-framework-javascript). AFJ is a framework written in TypeScript for building SSI Agents and DIDComm services. This demo uses the REST API, which is part of the [Aries Framework JavaScript Extensions](https://github.com/hyperledger/aries-framework-javascript-ext) repository.\n\n## 🛠️ Usage\n\n### Prerequisites\n\n- [NodeJS](https://nodejs.org/en/) v16.X.X - Other versions may work, not tested\n- [Yarn](https://classic.yarnpkg.com/en/docs/install)\n- [Git](https://git-scm.com/downloads) - You probably already have this\n\n### 🖥 Client\n\nCopy the `.env.example` file to a `.env` file and set the environment variables.\n\n```bash\ncd client\ncp .env.example .env\n```\n\n| Variable                   | Description                                                                                                      |\n| -------------------------- | ---------------------------------------------------------------------------------------------------------------- |\n| `REACT_APP_HOST_BACKEND`   | Used in the frontend application to connect with the backend. Should be `http://localhost:5000` for development. |\n| `REACT_APP_HOST_WEBSOCKET` | Used in the frontend application to connect with the WebSocket server and listen for events. Should be `ws://localhost:5000` for development. |\n\n### 🎛️ Server\n\nCopy the `.env.example` file to a `.env` file and set the environment variables.\n\n```bash\ncd server\ncp .env.example .env\n```\n\n| Variable                | Description                                                                                                        |\n| ----------------------- | ------------------------------------------------------------------------------------------------------------------ |\n| `AGENT_PUBLIC_DID_SEED` | Used in the backend application for the agent. Should be set to your agent's public DID in development/production. |\n| `AGENT_ENDPOINT`        | Used in the backend application for the agent. Should be set to your agent's endpoint in development/production.   |\n| `AGENT_WALLET_KEY`      | Used in the backend application for the agent. Should be set to your agent's wallet key in development/production. |\n\n### Node version\n\n```bash\nnvm use\n```\n\n### Install Dependencies\n\n```bash\nyarn install\n```\n\n### Development\n\n```bash\nyarn dev\n```\n\n### Tests\n\nThe demo has [Cypress](https://www.cypress.io/) integration tests. To run the tests, make sure you have both the client, server and test agent running locally. You can do this by running the commands `yarn dev` in the root of the project. You can then start the tests with `yarn test`. This will open up cypress in chrome from where you can run the tests.\n\n## 🖇️ How To Contribute\n\nYou're welcome to contribute to this demo. Please make sure to open an issue first!\n\nThis demo is open source and you're more than welcome to customize and use it to create your own self-sovereign identity demo. If you do, an attribution to [Animo](https://animo.id) would be very much appreciated!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanimo%2Fanimo-demo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanimo%2Fanimo-demo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanimo%2Fanimo-demo/lists"}