/abzu

Front-end for the stop place registry, Tiamat

Primary LanguageJavaScriptEuropean Union Public License 1.2EUPL-1.2

Abzu Build and deploy

Stop place register frontend. Uses stop place register backend tiamat's graphQL API

The app is built on top of Create React App.

Configuration

See src/config/enviroments for environment specific configuration.

Development

To run Abzu for development, simply do:

npm install
npm start

Note: This will launch the application with hot reload enabled.

Default port in development is 9000. This can be overrided by setting the environment variable port (notice lower case).

To override timatBaseURL (GraphQL endpoint), set TIAMAT_BASE_URL as environment variables, e.g.

TIAMAT_BASE_URL=https://api.dev.entur.org/stop_places/1.0/graphql port=9000 NODE_ENV=development node server.js

Testing

Uses Jest to test unit and reducer testing

npm test

Authentication

Uses OIDC for authentication. This solution is agnostic to which authentication provider you use.

Example configuration (works with Auth0):

{
    "oidcConfig": {
      "authority": "https://<authentication domain>",
      "client_id": "<client id>",
      "extraQueryParams": {
        "audience": "<example audience>"
      }
    }
}

For full configuration reference, see oidc-client-ts documentation.

Themes

Default theme is found in ./config/default .

Add custom theme

  • Create new directory: ./config/themes/{YOUR_THEME_NAME}
  • Add logo.png to ./config/themes/{YOUR_THEME_NAME}
  • Add index.js with custom fyles (cf. defaultTheme.js)
  • Set process.env.REACT_APP_THEME={YOUR_THEME_NAME}