Skip to content

RP-OIS-SK/RPOpenCertsRenderer

Repository files navigation

Build Status Quality Gate Status Coverage

Decentralised Document Renderer

The project allow you to run your own document renderer compatible with the OpenAttestation standards. To customise the look and feel of your document, you may style a template to render it, host a copy of this renderer and then point your document to render with the hosted renderer.

Running the renderer

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

You will notice a blank page. This is normal as the renderer does not render anything until a document object is passed into it.

To see the render in action, you may embed it in an iframe and use postMessage to interact with it.

A sample iframe html file is included in test/index.html to help you test your renderer.

Styling your document

The templates are defined in src/templates.

Basic styling

If you are only rendering one type of document, you may style the default template at src/templates/default/template.js.

Multiple document templates

If the renderer is meant to render more than one template, it will be differentiated by the document template name. The name of the template to render should correspond to the keys in src/components/templates/index.js.

Deploying the site

npm run build

Builds the site into a static site.
You may serve the site from the build folder.

About

RP Opencerts Decentralised Renderer

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages