Skip to content

Latest commit

 

History

History
66 lines (46 loc) · 2.43 KB

README.md

File metadata and controls

66 lines (46 loc) · 2.43 KB
Raw

User interface for CAG Racing Management System

CAG Racing Management System

Run application in development server

$ npm install && npm start

Build distro

The webpack config recognizes the following options through NPM scripts:

  • client-api: the server address of the client-api service in the back-end, e.g "http://localhost:10580"
  • build-info: a string providing information about the build, e.g "$(git log -1 --pretty='%H %cd')"; defaults to ${maven.build.timestamp}. This build info is displayed when clicking on "CAG DROID RACE"-logo in upper left corner.

These are picked up in the application.

Use when building/running via npm as in the following examples:

$ npm start -- --client-api="http://localhost:10580"

or

$ npm build:prod -- --client-api="http://localhost:10580"

Note, that the "--" is necessary.

Use when building via maven as follows

$ mvn clean install [ -Dclientapi.base=<clientapi server address> ] [-Dbuildinfo=<buildinfo>][ -Pclean-node ]
  • clean-node: this profile removes node/ and node_modules/

This installs node, npm and builds the entire web application.

Develop

Code structure

The application is available in src

  • src/index.html: main page
  • src/assets: images, fonts

Application structure

The following application modules exists

  • src/common: common stuff in the application
    • clientApi.service: service for accessing back-end
  • src/main: component that implements the main page contents with navigation bar and content area containing the other components.
  • src/overview: component that implements the overview view (<overview></overview>)
  • src/queue: component that implements the queue view (<cag-queue></cag-queue>)
  • src/leaderboard: component that implements the leaderboard view (<leaderboard></leaderboard>)
  • src/currentrace: component that implements the currentrace view (<current-race data-user="<user name>"></current-race>)
  • src/notification: service for showing error and info notifications

Debugging Events

When debugging it is possible to show notifications for all events received via the websocket channels.

This is done by setting the parameter ls.droid.showevents to true in the local storage of the browser (in chrome it is accessed in developer tools -> resources).