Skip to content
New issue

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

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

Already on GitHub? # to your account

some readme updates #120

Merged
merged 2 commits into from
Aug 6, 2019
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,21 @@ This demo showcases features such as:

## See it Live

The easiest way to see and test drive the demo is to go check it out on the [Developer Hub](https://demos.developer.virtru.com/protect/). This is also a helpful place to find more information about it all works, as well as "getting started" and "how-to" guides.

For a step-by-step guide on how to use the demo, please visit the [walkthrough](https://developer.virtru.com/docs/protect).
[Go here](https://demos.developer.virtru.com/protect/) to test drive the live demo. Afterwards, check the out Virtru's [Developer Hub](https://developer.virtru.com/docs/protect) for a step-by-step guide on how it all works.

## Run it Locally

If you want to run this demo locally, ensure that you have met the following pre-reqs:

- Node/NPM - Node and NPM are both requirements to build and run the example
- If you are running this example locally from a Windows machine, please ensure you use a POSIX-compatible environment such as Cygwin.
- Ensure that your `/etc/hosts` includes the following line: `127.0.0.1 local.virtru.com`
- Ensure that your `/etc/hosts` file includes the following line: `127.0.0.1 local.virtru.com` to avoid running into CORs errors

Now get it running:

```console
foo@bar:~$ git clone git@github.com:virtru/protect-and-track.git # Clone this repository
foo@bar:~$ npm ci && sudo npm start # Install and run locally
foo@bar:~$ npm ci; sudo npm start # Install and run locally
```

If running successfully, visit `https://local.virtru.com` and use the demo running from your computer.
Expand Down