Skip to content

README.rst

Latest commit

 

History

History
57 lines (38 loc) · 1.81 KB

README.rst

File metadata and controls

57 lines (38 loc) · 1.81 KB

PATo

Code CI Apache License

Source code https://github.com/DiamondLightSource/pato-frontend/

Particle Analysis and Tomography Visualization Interface

Configuration

Build time:

  • REACT_APP_VERSION: App version

Run time:

Create a configuration file named config.js, based on config.example.js, and mount custom runtime configs on the root of the deployment folder (e.g.: /usr/share/nginx/html for nginx). In local development mode, modify config.js in /public instead.

  • API_URL: base URL for API endpoints
  • AUTH_URL: base URL for authentication endpoints
  • DEV_CONTACT: email used for contacting application support
  • ENVIRONMENT: application environment - one of 'production', 'staging' or 'demo'
  • FEEDBACK_URL (optional): URL pointing to form that takes user feedback
  • REPROCESSING_ENABLED: whether to show or hide reprocessing buttons

Deployment

Running development server on your machine:

yarn install --immutable --immutable-cache --check-cache

yarn start

There is also a production Docker container available. Nevertheless, you can compile a production-optimised build with yarn build instead.

Testing

  • Run yarn test