Skip to content

Latest commit

 

History

History
101 lines (74 loc) · 5.44 KB

README.md

File metadata and controls

101 lines (74 loc) · 5.44 KB
Raw

decentralized-renderer-react-template

CircleCI Netlify Status

React boilerplate to write decentralize renderer.

Install

The easiest way to use decentralized-renderer-react-template is through github by clicking on Use this template button in the repository page.

You can also download or git clone this repo

$ git clone https://github.com/Open-Attestation/decentralized-renderer-react-template.git my-module
$ cd my-module
$ rm -rf .git
$ npm install

Make sure to edit the following files according to your module's info:

  • package.json (module name and version)
  • README.md
  • LICENSE
  • add your own template (in src/templates folder) and configure correctly the template registry (in src/templates/index.tsx file)

Commands

$ npm run storybook # open storybook and start editing your components
$ npm run storybook:build # generate docs
$ npm run test:watch # run tests with Jest
$ npm run test:coverage # run tests with coverage
$ npm run integration # run integration test with testcafe
$ npm run lint # lint code
$ npm run build # build component
$ npm run example:application # start embedded application

Code organization and development

  • index.ts contains the logic to communicate with the host embedding your renderer. You probably will never need to update that file.
  • template registry configuration is located in src/templates/index.tsx
  • templates are located in src/templates folder. You can add as many template as you want and structure the code the way you want
  • documents samples contains fake data to test the templates you build. You can create a typescript interface to make sure that your template uses the correct expected document
    • create a type describing the kind of document you expect to render (for instance check CustomTemplateCertificate in src/sample.tsx)
    • create a template consuming that interface, using the TemplateProps helper from @govtechsg/decentralized-renderer-react-components (for instance check the template insrc/templates/customTemplate/customTemplate.tsx`)
  • shared components are located in src/core folder. For instance you can find a watermark example that will be displayed when printing the document
  • feel free to remove whatever you dont need

Testing the templates in an integrated environment

This template provides a simple application that is able to render documents built for the current renderer. To use it:

  1. Open application/index.tsx file and edit the documents property of the App component to suit your needs (provide any document that is available locally, whether it's a javascript, JSON or typescript document).
  2. Start your renderer: npm run dev
  3. Start the local application: npm run example:application
  4. Head to http://localhost:3010/, you should see the configured documents during step 1.

End-to-end and visualisation test

This repository has been configured to run end-to-end tests using Testcafe. Visualisation testing is also configured through Percy and tests are ran through Testcafe.

To setup Percy, you will need a token that you can find on Percy's dashboard:

  • For local development, type export PERCY_TOKEN=<PERCY_TOKEN> before running npm run integration.
  • For CircleCI, add an environment variable PERCY_TOKEN with the token value.

Features

  • React - A JavaScript library for building user interfaces.
  • Webpack - Component bundler.
  • React testing library - Simple and complete testing utilities that encourage good testing practices.
  • Emotion - Library designed for writing css styles with JavaScript.
  • Babel - Write next generation JavaScript today.
  • Jest - JavaScript testing framework used by Facebook.
  • Testcafe - A node.js tool to automate end-to-end web testing.
  • Percy - Visualisation testing tool.
  • ESLint - Make sure you are writing a quality code.
  • Prettier - Enforces a consistent style by parsing your code and re-printing it.
  • Typescript - JavaScript superset, providing optional static typing
  • Circle CI - Automate tests and linting for every push or pull request.
  • Storybook - Tool for developing UI components in isolation with documentation.
  • Debug - JS debugging utility that works both in node.js and browsers.

Changing stuff

Removing Emotion

  • Uninstall npm packages
$ npm uninstall @emotion/core @emotion/styled @emotion/babel-preset-css-prop
  • Remove @emotion/babel-preset-css-prop from Babel presets (configuration is made in package.json file)
  • Remove @emotion/core from Typescript configuration (in tsconfig.json file)
  • Remove .storybook/webpack.config.js (file created only for emotion css property support in storybook)

License

GPL-3.0