Skip to content

bcgov/aries-vcr-client

Repository files navigation

License img

Aries VCR Client

Overview

This application implements a user interface (built with Angular) for Aries VCR, calling the API to search and consume data about credentials.

Note: The following sections on Running and Development assume that you already have a locally running instance of Aries-VCR. Please see the instructions here for running Aries-VCR locally with docker.

Running

Running the web application is easiest with docker. Navigate to the docker/ folder run the following in a terminal:

./manage build

followed by

./manage start

Development

Development is best done locally and requires the Angular CLI to be installed (see the installation instructions here). With the CLI installed, navigate to the root directory of the repository and run the following in a terminal:

npm install && npm start

The application will be built and served with the Angular Dev Server, which watches for code changes and hot-reloads the application.

Themes

Themes can be customized by extending this codebase. Simply create a fork of the repository and start coding!

The following examples showcase cusotmized UIs using this Aries VCR Client as a base:

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.

Contributing

Pull requests are always welcome!

Please see the Contributions Guide for the repo.

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.

License

Apache License Version 2.0