History

Richard Bowman cbd8b090ec Replace tasksubmitter with action-button I've changed tasksubmitter to accept a "thing" and "action" rather than a single URL. This seems more in keeping with propertyControl, and eliminates the need for loads of computed properties. I've also deleted (rather than just commenting out) chunks of the web app that are no longer in use. These may be reinstated in the future - but we can get them from git history. It's less confusing not to have vestigial code in the repo. This builds OK but is not, as yet, tested with hardware.		2024-02-29 21:44:39 +00:00
..
public	Rename js directory to webapp	2021-09-16 15:13:19 +01:00
src	Replace tasksubmitter with action-button	2024-02-29 21:44:39 +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
    }
}