Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 2.59 KB

README.md

File metadata and controls

60 lines (38 loc) · 2.59 KB

RKVST Documentation

This is the Home of the RKVST Documentation

The RKVST API enables proof of origin, proof of authenticity and proof of provenance for any digital asset. It is organized around REST (https://en.wikipedia.org/wiki/Representational_state_transfer).

The RKVST API can easily be connected to existing data in the cloud or on-prem to provide instantly verifiable data integrity, transparency & trust services for private and public assets.

These docs describe all the capabilities of the RKVST API including:

  • creation, management & security of provenance metadata
  • access controls for private and public asset sharing
  • compliance policies to continuously monitor vulnerabilies
  • administration controls for management of users, applications and relationships with 3rd parties

An interactive RKVST API console to run tests and generate code which can be quickly added into any application is a available in the free service we offer at www.rkvst.com.

Contributing

To contribute to these Docs please refer to our Contributing Guidelines

We'll happily review any suggestions!

Getting Started

  1. To begin pull the latest RKVST docs from Github.
git clone [email protected]:rkvst/rkvst-docs.git
  1. Move into the directory.
cd rkvst-doks
  1. Install the DOKS Dependencies.
npm install
  1. To run a local RKVST Docs Server it is advisable to use the rkvst-doks wrapper
rkvst-doks start

This will build a local version of the server that can be accessed at http://localhost:1313.

Credits

This Documentation was put together using some amazing opensource tools and projects, this is a list of known projects included but is not exhaustive