History

Richard Bowman 29177d7214 Scroll to the bottom when status messages appear The log viewer was scrolling to the bottom when new logs appeared, but not when the status updated. This meant that the status update may have been invisible. I now scroll when the status changes too, which should fix the problem.		2024-01-10 20:46:06 +00:00
..
public	Rename js directory to webapp	2021-09-16 15:13:19 +01:00
src	Scroll to the bottom when status messages appear	2024-01-10 20:46:06 +00:00
.env.development	Update build output location	2024-01-03 20:50:33 +00:00
.env.production	Rename js directory to webapp	2021-09-16 15:13:19 +01:00
.eslintrc.js	Rename js directory to webapp	2021-09-16 15:13:19 +01:00
.gitignore	Rename js directory to webapp	2021-09-16 15:13:19 +01:00
babel.config.js	Rename js directory to webapp	2021-09-16 15:13:19 +01:00
CONTRIBUTING.md	Rename js directory to webapp	2021-09-16 15:13:19 +01:00
LICENSE	Rename js directory to webapp	2021-09-16 15:13:19 +01:00
package-lock.json	Switch to matierial-symbols	2024-01-03 20:51:32 +00:00
package.json	Switch to matierial-symbols	2024-01-03 20:51:32 +00:00
README.md	WIP: update webapp to use new backend	2023-09-04 22:00:56 +01:00
vue.config.js	Update build output location	2024-01-03 20:50:33 +00:00

README.md

OpenFlexure Microscope JS Client

Key info

Vue.js web application providing a graphical interface for the OFM
Once built, will be served by the API server from the host root on port 5000
See openflexure-microscope-server/README.md for details on local installation and building

Developer guidelines

Creating releases

JS client is coupled to the API, and so are no longer separately built and deployed.
See openflexure-microscope-server/README.md for details on creating new releases

Installing

Install Node.js (and npm)
Install dependencies with npm install
Node v18 changes SSL, and so you need $env:NODE_OPTIONS = "--openssl-legacy-provider" on Windows or export NODE_OPTIONS=--openssl-legacy-provider on Linux/MacOS for compatibility.
Build the static web app with npm run build
Serve a development version with npm run serve

VS Code and ESLint

To prevent the editor from interfering with ESLint, add to your project settings.json:

{
    "editor.tabSize": 2,
    "cSpell.enabled": false,
    "eslint.validate": ["vue","javascript", "javascriptreact"],
    "editor.formatOnSave": false,
    "vetur.validation.template": false,
    "editor.codeActionsOnSave": {
        "source.fixAll.eslint": true
    }
}