Giter Club home page Giter Club logo

animo-demo's Introduction


screenshot-demo

Animo Self-Sovereign Identity Demo

Continuous Integration Continuous Deployment License TypeScript

โœจ Hi there!

Welcome to the repository of Animo's Self-Sovereign identity demo. This interactive app demonstrates the use of verifiable credentials. This demo is build using Aries Framework Javascript (AFJ). 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 repository.

๐Ÿ› ๏ธ Usage

Prerequisites

  • NodeJS v16.X.X - Other versions may work, not tested
  • Yarn
  • Git - You probably already have this

๐Ÿ–ฅ Client

Copy the .env.example file to a .env file and set the environment variables.

cd client
cp .env.example .env
Variable Description
REACT_APP_HOST_BACKEND Used in the frontend application to connect with the backend. Should be http://localhost:5000 for development.
REACT_APP_INSIGHTS_PROJECT_ID Used in the frontend application for analytics using https://getinsights.io. Should not be set for local development.

๐ŸŽ›๏ธ Server

Copy the .env.example file to a .env file and set the environment variables.

cd server
cp .env.example .env
Variable Description
AGENT_PUBLIC_DID_SEED Used in the backend application for the agent. Should be set to your agent's public DID in development/production.
AGENT_ENDPOINT Used in the backend application for the agent. Should be set to your agent's endpoint in development/production.
AGENT_WALLET_KEY Used in the backend application for the agent. Should be set to your agent's wallet key in development/production.

Node version

nvm use

Install Dependencies

yarn install

Development

yarn dev

Tests

The demo has Cypress integration tests. To run the tests, make sure you have both the client and the server running locally. You can start the tests with yarn test. This will open up cypress in chrome from where you can run the tests.

How To Contribute

You're welcome to contribute to this demo. Please make sure to open an issue first!

animo-demo's People

Contributors

janrtvld avatar timoglastra avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.