Sonor app

Installation

Requirements

• Node.js (version > 10.15)
• npm or yarn

Install dependencies

npm install or yarn install

Configuration

Configuration of the application

If you need, the configuration of the application can be modified in the configuration.json file :

  "PEARL_JAM_URL": "http://localhost:7777", (URL of the PearlJamApi, defaut value is the mocked_apis_server)
  "QUEEN_URL_BACK_END": "http://localhost:7777", (URL of the QueenApi, defaut value is the mocked_apis_server)
  "QUEEN_URL_FRONT_END": "http://localhost:7777", (URL of the PearlJam application, defaut value is the mocked_apis_server)

  "AUTHENTICATION_MODE": "anonymous" (choose between "anonymous" or "keycloak")

Keycloak configuration

If you need, the configuration of the keycloak server for the application can be modified in the keycloak.json file :

  "realm": "insee-realm",
  "auth-server-url": "http://localhost:8180/auth",
  "ssl-required": "external",
  "resource": "sonor",
  "public-client": true,
  "confidential-port": 0

Usage

Start the app

npm start or yarn start

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

The page will reload if you make edits.
You will also see any lint errors in the console.

Start mock servers

To test the application at this point you need to use the server mocked_apis_server to serve the pearlJam APIs. You will find it at the root of this project : /mocked_apis_server

cd ./mocked_apis_server

Run the following commands to install and start the server:

npm install (or yarn install)

npm start (or yarn start)

Run unit tests with jest

npm run test or yarn run test

To see the tests coverage: npm test -- --coverage (or yarn test -- --coverage)

End to end tests with cypress

npm run cypress:open or yarn run cypress:open