fullboar / vc-showcase Goto Github PK

View Code? Open in Web Editor NEW

This project forked from bcgov/bc-wallet-demo

0.0 1.0 2.0 14.12 MB

Themeable Demo of Verifiable Credentials

License: Apache License 2.0

JavaScript 2.36% TypeScript 95.63% CSS 0.10% HTML 1.43% Dockerfile 0.49%

credentials

vc-showcase's Introduction

Showcase for Verifiable Credentials

Overview

This application provides a showcase to illustrate the use cases for verifiable credentials. This application will take users through multiple steps to demonstrate how verifiable credentials are issued and verified using a compatible wallet of your choosing.

Running

.env files

Copy the files api/.env.example and web/.env.example to api/.env and web/.env. Edit the .env files to match your project needs.

Option 1 - Native

Please make sure you have a recent version of node and yarn installed. These steps are executed from the root folder of the project:

yarn install

Run the api and any of the front end components (e.g. web) in separate terminals:

To start the api:

cd api
yarn run dev

To start the web or verifier just use the start script that comes standard with a React Native project:

cd web
yarn start

The showcase application will now be running at http://localhost:3000 which you can open in your browser if it doesn't open automatically.

cd verifier
yarn start

The verifier application will now be running at http://localhost:3001 which you can open in your browser if it doesn't open automatically.

Option 2 - Docker

This project comes with a docker-compose.yaml file which can be used to run the project in a docker container. This is the recommended way to run the project.

You can run each container seporatly if you wish. Running docker containers is outside the scope of this document. Please refer to the Docker documentation for more information.

docker compose up

🤓 Pro-tip

Older version of Docker may need to use docker-compose up instead of docker compose up.
If you want to run the containers in the background use docker compose up -d.

Contributing

Pull requests are always welcome!

Please see the Contributions Guide for the repo.

Before contributing please run yarn lint --fix and fix any linter warnings in your code contribution.

You may also create an issue if you would like to suggest additional resources to include in this repository.

All contrbutions to this repository should adhere to our Code of Conduct.

vc-showcase's People

Watchers

Forkers

chrisf15 pkkarn

vc-showcase's Issues

Ensure that project packages are up-to-date

Ensure the proejct packages are up-to-date:

React
Supporting packages

The project should be reactive displaying correctly on mobile devices

This project should display properly on mobile devices such and phones and tablets.

Support for multiple languages

The project should support multiple languages via standard localization and internationalization techniques. At the end of this feature strings should be located in mechanism which allows them to be changed via a component on the Web UI. For example, the user can switch between "English" and "French" with one set as a default.

All credential mechanics should be configurable programatically

When the project is run, or via a script, it should create any necessary credential schemas as well as have other supporting mechanics like related proof requests stored in a configurable way. These can be loaded and build or run-time. For example:

If one deployment wants to use a "dog licensing example" and another chooses to use a "wood cutting permit" some UI changes will be required, especially around the text displayed to the user. This is expected. However, each of these examples will have different Verifiable Credential (VC) components. These VC components should be configurable via JSON or YAML.

Ensure that the project builds without error

The project should build yarn run build without error:

No typescript / tsc errors;
No eslint errors.

The project should support issue credentials via OpenID4VCI

This project should support issuing credentials in the demo via OpenID4VCI so this mechanism can be demonstrated as part of the "Showcase" functionality.

Evaluate code to determine refactoring needed for theming

We would like to be able to deploy this project with different themes which include changes to:

primary name i.e "Government of X Showcase";
color pallet;
primary graphics such as logo(s);
font

Review the project code base and report back in this ticket what additional tickets need to be created to facilitate the above capabilities.