https://github.com/diamondlightsource/pato-frontend
Particle analysis and tomography data display application (frontend)
https://github.com/diamondlightsource/pato-frontend
react ui
Last synced: about 2 months ago
JSON representation
Particle analysis and tomography data display application (frontend)
- Host: GitHub
- URL: https://github.com/diamondlightsource/pato-frontend
- Owner: DiamondLightSource
- License: apache-2.0
- Created: 2023-03-03T10:04:13.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2025-10-06T12:28:24.000Z (6 months ago)
- Last Synced: 2025-10-06T14:22:42.986Z (6 months ago)
- Topics: react, ui
- Language: TypeScript
- Homepage:
- Size: 6.75 MB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE
Awesome Lists containing this project
README
PATo
===========================
|code_ci| |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.: :code:`/usr/share/nginx/html` for nginx). In local development mode, modify :code:`config.js` in :code:`/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:
.. code-block:: bash
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 :code:`yarn build` instead.
============
Testing
============
- Run :code:`yarn test`
.. |code_ci| image:: https://github.com/DiamondLightSource/pato-frontend/actions/workflows/test.yml/badge.svg
:target: https://github.com/DiamondLightSource/pato-frontend/actions/workflows/test.yml
:alt: Code CI
.. |license| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
:target: https://opensource.org/licenses/Apache-2.0
:alt: Apache License