Vite

.bumpversion.cfg

@@ -18,3 +18,4 @@ values =
 [bumpversion:part:build]
 
 [bumpversion:file:omero_figure/utils.py]
+[bumpversion:file:src/.env]

.gitignore

@@ -8,6 +8,5 @@ node_modules/
 _site
 dist
 omero_figure.egg-info
-omero_figure/static/figure/figure.js
-omero_figure/static/figure/templates.js
-omero_figure/static/figure/3rdparty/shape-editor*
+omero_figure/templates/
+omero_figure/static/omero_figure/

README.rst

@@ -131,9 +131,7 @@ above. If using *Option 1*, you need to *replace* the existing script:
 Development
 -----------
 
-We use Grunt for various tools.
-See http://figure.openmicroscopy.org/2014/05/01/testing-with-jshint-jasmine-grunt.html
-for an introduction.
+We use `vite.js <https://vitejs.dev/>`_ to build and serve the app during development.
 
 Install Node from https://nodejs.org, then:
 
@@ -142,57 +140,55 @@ Install Node from https://nodejs.org, then:
     $ cd omero-figure
     $ npm install
 
-Install Grunt CLI as described on http://gruntjs.com/using-the-cli.
-
-To build various resources into ``omero_figure/static``  run:
+To serve the app at http://localhost:8080/ using the vite dev server
+(this will automatically refresh the page when changes are saved):
 
 ::
 
-    $ grunt build
+    $ npm run start
 
-This will concatenate js files into a single figure.js file,
-compile the underscore templates into templates.js and also
-copy the shape-editor.js from node_modules.
+If you are editing the Shape-Editor code, you can view the test page at
+http://localhost:8080/shapeEditorTest.html
 
-During development, you will want to peform the concatenation
-(``concat``) and template compilation (``jst``) tasks whenever
-the JavaScript or template files change. This can be achieved
-with:
 
-::
+CORS
+****
 
-	$ grunt watch
+During development, we load and save figure files to an omero-web server.
+You will need to have CORS enabled on your local omero-web server at
+http://localhost:4080/ and be logged in already.
+This URL can be edited in `src/index.html`.
 
-It is also possible to develop figure in docker without installing anything locally.
-The Docker image is built on top of ``openmicroscopy/omero-web-standalone:latest``, so you will have a fully functional
-omero-web environment while developing ``omero-figure``. 
-First build the Docker image:
+You MUST access the figure app at http://localhost:8080/ (NOT http://127.0.0.1:8080/)
+for CORS to work.
 
-::
+NB: in general, POST actions such as saving of figure files or exporting figures doesn't
+yet work with the dev server. To test these actions, build the app as described below:
 
-   $ docker build -t figure-devel .
 
+Build
+-----
+
+To build the app:
 
-To develop ``omero-figure`` you can either make all the changes within the Docker container itself by running:
 ::
 
+   $ npm run build
 
-    $ docker run -ti -e OMEROHOST=YOUR_HOST -p 4080:4080 figure-devel
+This compiles index.html and other static assets into correct locations to be
+served by the Django `omero-web` server.
 
-The preferred option is to mount the repository containing the omero-figure code. Make the changes locally and see the changes in the docker container. To do so, run:
+To serve this on a local omero-web, set config as above and install with:
 
 ::
-    $ docker run -ti -e OMEROHOST=YOUR_HOST -p 4080:4080  -v /PATH_TO_GIT_REPO/omero-figure:/home/figure/src figure-devel
 
+   $ pip install -e .
 
-After starting the container, run ``docker ps`` in another terminal to find the ID of the container. Then run:
+In order to build whenever changes are saved within the `src/` directory:
 
 ::
 
-   $ docker exec -u 0 -it CONTAINER_ID bash   # replace CONTAINER_ID by the correct value
-   $ cd /home/figure/src
-   $ grunt watch
-
+    $ npm run watch
 
 
 Release process

deploy_build.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+echo "Deploying built resources to plugin directory..."
+
+# copy bootstrap-icons from node_modules to static...
+mkdir -p omero_figure/static/omero_figure/fonts/
+cp node_modules/bootstrap-icons/font/bootstrap-icons.css omero_figure/static/omero_figure/
+cp node_modules/bootstrap-icons/font/fonts/bootstrap-icons.woff2 omero_figure/static/omero_figure/fonts/
+
+# output dir is static dir (js & css in correct place) - only need to move index.html
+mkdir -p omero_figure/templates/omero_figure/
+cp omero_figure/static/omero_figure/index.html omero_figure/templates/omero_figure/