Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated development documentation #144

Merged
merged 1 commit into from
Feb 9, 2022

Conversation

wadeking98
Copy link
Contributor

Updated development documentation for Orgbook
Resolves: #107
Signed-off-by: wadeking98 wkingnumber2@gmail.com

Copy link
Member

@WadeBarnes WadeBarnes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small change. Other than that it looks good.

README.md Outdated
@@ -25,50 +25,46 @@ followed by

## Development

### Getting Started
The Orgbook BC project sits on top of verifiable credential technology facilitated by Aries VCR. A locally running instance of Aries VCR is not required to
run the Orgbook BC web application on your own machine. By default Orgbook BC forwards API calls to the publicly running instance of the Orgbook API [here](https://orgbook.gov.bc.ca/api/). The Orgbook API is simply an Aries VCR instance containing credential information about BC Business entities. You can change your local instance of Orgbook to point to any running instance of an Aries VCR agent by editing the `vue.config.js` file outlined in this section [here](#proxy-configuration). If you would like to setup a locally running instance of Aries VCR to test with Orgbook, then follow the instructions [here](https://github.com/bcgov/aries-vcr/tree/master/docs). To run Orgbook in development mode look at the project setup section [here](#project-setup)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unnecessary line break.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

line break removed

Signed-off-by: wadeking98 <wkingnumber2@gmail.com>
@WadeBarnes WadeBarnes merged commit ca03879 into bcgov:main Feb 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update development documentation
2 participants