chriamue / selv-mobile Goto Github PK

⚠ Please note that this branch won't work for the official Selv experiences, since this branch holds the new and improved version of the Selv mobile app. For an app that is compatible with the official Selv experiences please refer to the main branch.

First you need to install Node.JS if you haven’t done that already.

Install Yarn Node.js dependency manager:

curl -o- -L https://yarnpkg.com/install.sh | bash

Clone repository by running:

git clone https://github.com/iotaledger/selv-mobile.git

To install the dependencies, run:

yarn

To run the application locally, run:

yarn web

and open http://localhost:3001 in your favourite browser.

To build the application for iOS or android, some additional dependencies need to be installed.

To start the build process, run yarn ios or yarn android.

This chapter will guide you through the process of adding your own credential types to the Selv-App.

Add your JSON-Schemas to ui/lib/identity/schemas/index.

You can enrich the display of credentials and presentations by adding enrichments to ui/lib/identity/schemas/index.

You can supply overrides for:

• issuerLabel: as a string
• logo: as a string pointing to a file (see the next paragraph)
• theme: as a HEX string like #FF0000

Add your logo files to ui/assets. Square.png's work best.

Setup a mapping between the logo ID and the path in ui/lib/helpers.

You can use the included CLI to generate a credential. Supply the name of schema as defined in "Add Credential Schemas" and a path to your input data.

yarn cli SCHEMANAME path/to/data.json

The CLI will generate a QR-Code encoding the new credential at .cli/credential.svg, which you can scan in the app.

Scan the generated QR-Code from the previous step in the app to store it.

You can present your stored credentials to another Selv-User to validate it in their app.