Skip to content

Latest commit

 

History

History
 
 

demo

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src
src
 
 
README.md
README.md
 
 
package.json
package.json
 
 
tsconfig.json
tsconfig.json
 
 

README.md

DEMO

This is the Aries Framework Javascript demo. Walk through the AFJ flow yourself together with agents Alice and Faber.

Alice, a former student of Faber College, connects with the College, is issued a credential about her degree and then is asked by the College for a proof.

Features

  • ✅ Creating a connection
  • ✅ Offering a credential
  • ✅ Requesting a proof
  • ✅ Sending basic messages

Getting Started

Platform Specific Setup

In order to use Aries Framework JavaScript some platform specific dependencies and setup is required. See our guides below to quickly set up you project with Aries Framework JavaScript for NodeJS, React Native and Electron.

Run the demo

These are the steps for running the AFJ demo:

Clone the AFJ git repository:

git clone https://github.com/hyperledger/aries-framework-javascript.git

Open two different terminals next to each other and in both, go to the demo folder:

cd aries-framework-javascript/demo

Install the project in one of the terminals:

yarn install

In the left terminal run Alice:

yarn alice

In the right terminal run Faber:

yarn faber

Usage

To set up a connection:

  • Select 'receive connection invitation' in Alice and 'create connection invitation' in Faber
  • Faber will print a invitation link which you then copy and paste to Alice
  • You have now set up a connection!

To offer a credential:

  • Select 'offer credential' in Faber
  • Faber will start with registering a schema and the credential definition accordingly
  • You have now send a credential offer to Alice!
  • Go to Alice to accept the incoming credential offer by selecting 'yes'.

To request a proof:

  • Select 'request proof' in Faber
  • Faber will create a new proof attribute and will then send a proof request to Alice!
  • Go to Alice to accept the incoming proof request

To send a basic message:

  • Select 'send message' in either one of the Agents
  • Type your message and press enter
  • Message sent!

Exit:

  • Select 'exit' to shutdown the agent.

Restart:

  • Select 'restart', to shutdown the current agent and start a new one