rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Consistent single backtick code

Browse source
This commit is contained in:
Richard Bowman 2021-04-21 10:35:09 +01:00
parent 9783dfaeff
commit 4629fa67c6
1 changed files with 12 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -31,9 +31,9 @@ There are 2 important settings files:
## Creating releases ## Creating releases
* Update the applications internal version number * Update the applications internal version number
* Edit ``setup.py`` to update the version number * Edit `setup.py` to update the version number
* Git commit and git push * Git commit and git push
* Create a new version tag on GitLab (e.g. ``v2.6.11``) * Create a new version tag on GitLab (e.g. `v2.6.11`)
* Make sure you prefix a lower case 'v', otherwise it won't be recognised as a release! * Make sure you prefix a lower case 'v', otherwise it won't be recognised as a release!
* This tagging will trigger a CI pipeline that builds the JS client, tarballs up the server, and deploys it * This tagging will trigger a CI pipeline that builds the JS client, tarballs up the server, and deploys it
* Note: This also updates the build server's nginx redirect map file * Note: This also updates the build server's nginx redirect map file
@ -58,12 +58,12 @@ The Raspberry Pi image we use currently ships with Python 3.7.3. For local devel
* `pipenv install --dev` (This will install development dependencies. If you don't need these, `pipenv install` will get you just the dependencies needed to run the server, which takes about half the time.) * `pipenv install --dev` (This will install development dependencies. If you don't need these, `pipenv install` will get you just the dependencies needed to run the server, which takes about half the time.)
* Finally, run the server: * Finally, run the server:
* You can use `ofm serve` or `ofm restart` on the Raspberry Pi to manage the server. * You can use `ofm serve` or `ofm restart` on the Raspberry Pi to manage the server.
* To run the server locally, with dummy hardware, you can use ``python -m openflexure_microscope.api.app`` to start a development-mode Flask server on ``localhost:5000`` * To run the server locally, with dummy hardware, you can use `python -m openflexure_microscope.api.app` to start a development-mode Flask server on `localhost:5000`
### Set up the Javascript environment and build ### Set up the Javascript environment and build
* The Flask web application, written in Python, serves a web application written in ``Vue.js``. This is distributed as part of the built version of the server, hosted on our [build server](https://build.openflexure.org/openflexure-microscope-server/). * The Flask web application, written in Python, serves a web application written in `Vue.js`. This is distributed as part of the built version of the server, hosted on our [build server](https://build.openflexure.org/openflexure-microscope-server/).
* You could extract the pre-built web app from this tarball, which saves you having to set up Node.js. However, it also means you're not able to change the interface, and it's possible your interface will get out of sync with your server. * You could extract the pre-built web app from this tarball, which saves you having to set up Node.js. However, it also means you're not able to change the interface, and it's possible your interface will get out of sync with your server.
* Building the web interface will require a valid Node.js installation. If you don't have Node.js (including ``npm``) the [Node.js website](https://nodejs.org/en/) offers downloads for all platforms, though see the instructions below for Raspberry Pi. * Building the web interface will require a valid Node.js installation. If you don't have Node.js (including `npm`) the [Node.js website](https://nodejs.org/en/) offers downloads for all platforms, though see the instructions below for Raspberry Pi.
* To install Node.js on a Raspberry Pi: * To install Node.js on a Raspberry Pi:
* `curl -sL https://deb.nodesource.com/setup_14.x | sudo bash -` * `curl -sL https://deb.nodesource.com/setup_14.x | sudo bash -`
* `sudo apt install nodejs` * `sudo apt install nodejs`
@ -73,10 +73,10 @@ The Raspberry Pi image we use currently ships with Python 3.7.3. For local devel
* `npm run build` * `npm run build`
* To create a Node.js development server (this will help various development tools to display more information, and auto-rebuilds when you change the source files) * To create a Node.js development server (this will help various development tools to display more information, and auto-rebuilds when you change the source files)
* `npm run serve` * `npm run serve`
* You access the development server on a different port (it's printed on the command line when you run the above command). This means that when it starts up you will need to tell it where the microscope server is, using the "override API origin" field in the page that pops up. If you are running a test server on your computer, this is most likely ``http://localhost:5000/``. * You access the development server on a different port (it's printed on the command line when you run the above command). This means that when it starts up you will need to tell it where the microscope server is, using the "override API origin" field in the page that pops up. If you are running a test server on your computer, this is most likely `http://localhost:5000/`.
## Formatting, linting, and tests ## Formatting, linting, and tests
All of the commands below assume that you are running in the OFM virtual environment, i.e. you have run ``ofm activate`` on an OpenFlexure SD card, or ``source .venv/bin/activate`` on Linux, or ``.venv/Scripts/activate``on Windows. All of the commands below assume that you are running in the OFM virtual environment, i.e. you have run `ofm activate` on an OpenFlexure SD card, or `source .venv/bin/activate` on Linux, or `.venv/Scripts/activate`on Windows.
### Tl;dr ### Tl;dr
@ -84,8 +84,8 @@ All of the commands below assume that you are running in the OFM virtual environ
* To auto-format the Python code run `poe format` * To auto-format the Python code run `poe format`
* To auto-format the Javascript code, run * To auto-format the Javascript code, run
* ``cd openflexure_microscope/api/static`` * `cd openflexure_microscope/api/static`
* ``npm run lint`` * `npm run lint`
Auto-formats the code Auto-formats the code
@ -93,8 +93,8 @@ Auto-formats the code
* To auto-format and type-check the Python code run `poe check` * To auto-format and type-check the Python code run `poe check`
* To auto-format the Javascript code, run * To auto-format the Javascript code, run
* ``cd openflexure_microscope/api/static`` * `cd openflexure_microscope/api/static`
* ``npm run lint`` * `npm run lint`
Formats code, lints, runs static analysis, and runs unit tests. Formats code, lints, runs static analysis, and runs unit tests.
@ -129,7 +129,7 @@ Though not in the CI, our `format` script also runs isort:
## Build-system ## Build-system
As of ``2.10.0b0`` we have switched to using ``pipenv`` for managing dependencies, and a standard ``setuptools`` based build system. See "local installation" above for instructions on how to install the project. As of `2.10.0b0` we have switched to using `pipenv` for managing dependencies, and a standard `setuptools` based build system. See "local installation" above for instructions on how to install the project.
## Changelog generation ## Changelog generation