Skip to content

Latest commit

 

History

History

demo-app-video

Monk Demo App

This application is a demo app used to showcase how to implement the Monk workflow (authentication, inspection creation, inspection capture and inspection report) using the MonkJs SDK.

Features

This app contains the following features :

  • Authentication guards to enforce user log in
  • User log in with browser pop-up using Auth0 and token caching in the local storage
  • Automatic creation of a Monk inspection
  • Inspection capture using the PhotoCapture workflow
  • Redirection to the Monk inspection report app (since the inspection report component is not yet available in MonkJs 4.0)
  • Possiblity of passing the following configuration in the URL search params :
    • Encrypted authentication token using ZLib (the user does not have to log in)
    • Inspection ID (instead of creating a new one automatically)
    • Vehicle type used for the Sights (default one is CUV)
    • Application language (English / French / German / Dutch)

Running the App

In order to run the app, you will need to have NodeJs >= 16 and Yarn 3 installed. Then, you'll need to install the required dependencies using the following command :

yarn install

You then need to copy the local environment configuration available in the env.txt file at the root of the directory into an env file called .env :

cp env.txt .env

You can then start the app by running :

yarn start

The application is by default available at https://localhost:17200/.

Building the App

To build the app, you simply need to run the following command :

yarn build

Don't forget to update the environment variables defined in your .env file for the target website.

Testing

Running the Tests

To run the tests of the app, simply run the following command :

yarn test

To run the tests as well as collecgt coverage, run the following command :

yarn test:coverage

Analyzing Bundle Size

After building the app using the yarn build command, you can analyze the bundle size using the following command :

yarn analyze

This will open a new window on your desktop browser where you'll be able to see the sizes of each module in the final app.