openflexure-microscope-server/README.md
2020-06-05 09:45:14 +01:00

41 lines
No EOL
1.1 KiB
Markdown

# OpenFlexure Microscope JS Client
[![pipeline status](https://gitlab.com/openflexure/openflexure-microscope-jsclient/badges/master/pipeline.svg?style=flat-square)](https://gitlab.com/openflexure/openflexure-microscope-jsclient/commits/master)
A user client for the OpenFlexure Microscope, written in Vue.js.
## Install
A general guide on setting up your microscope can be found [here on our website](https://www.openflexure.org/projects/microscope/).
## Develop
* Clone the repo, and run `npm install`
* Scripts to build and serve are included in `package.json`
## Developer notes
### 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": [{
"language": "vue",
"autoFix": true
},
{
"language": "javascript",
"autoFix": true
},
{
"language": "javascriptreact",
"autoFix": true
}
],
"eslint.autoFixOnSave": true,
"editor.formatOnSave": false,
"vetur.validation.template": false
}
```