Merge branch 'develop' of github.com:strangetom/ingredient-parser into develop

Author: strangetom

.pre-commit-config.yaml

@@ -5,26 +5,52 @@ repos:
     rev: v5.0.0
     hooks:
       - id: check-added-large-files
+        name: (base:repo) debug-statements
         args: ['--maxkb=5000']
         stages: [pre-commit]
       - id: check-ast
+        name: (base:repo) check-ast
         stages: [pre-commit]
       - id: check-toml
+        name: (base:repo) check-toml
         stages: [pre-commit]
       - id: check-yaml
+        name: (base:repo) check-yaml
         stages: [pre-commit]
       - id: debug-statements
+        name: (base:repo) debug-statements
         stages: [pre-commit]
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.11.6
     hooks:
       - id: ruff
+        name: (base:repo) ruff
         args: ["--fix"]
         stages: [pre-commit]
       - id: ruff-format
+        name: (base:repo) ruff-format
         stages: [pre-commit]
   - repo: https://github.com/sphinx-contrib/sphinx-lint
     rev: v1.0.0
     hooks:
       - id: sphinx-lint
+        name: (docs:repo) sphinx-lint
         stages: [pre-commit]
+  - repo: local
+    hooks:
+      - id: biome-check-ts-js
+        name: (webtools:repo) biome check typescript/javascript
+        entry: npx @biomejs/biome check --write ./webtools/src --config-path=./webtools/biome.json --files-ignore-unknown=true --no-errors-on-unmatched
+        language: node
+        types: [text]
+        files: "\\.(jsx?|tsx?|c(js|ts)|m(js|ts)|d\\.(ts|cts|mts)|jsonc?)$"
+        exclude: ^docs/
+        require_serial: true
+      - id: biome-check-css
+        name: (webtools:repo) biome check css
+        entry: npx @biomejs/biome check --write ./webtools/src --config-path=./webtools/biome.json --files-ignore-unknown=true --no-errors-on-unmatched
+        language: node
+        types: [text]
+        files: "\\.(css?)$"
+        exclude: ^docs/
+        require_serial: true

README.md

@@ -59,7 +59,9 @@ Word-level results:
 
 ## Development
 
-The development dependencies are in the ```requirements-dev.txt``` file. Details on the training process can be found in the [Model Guide](https://ingredient-parser.readthedocs.io/en/latest/guide/index.html) documentation.
+**Basic**
+
+The development dependencies are in the `requirements-dev.txt` file. Details on the training process can be found in the [Model Guide](https://ingredient-parser.readthedocs.io/en/latest/guide/index.html) documentation.
 
 Before committing anything, install [pre-commit](https://pre-commit.com/) and run
 ```
@@ -68,16 +70,34 @@ pre-commit install
 
 to install the pre-commit hooks.
 
-Please target the **develop** branch for pull requests. The main branch is used for stable releases and hotfixes only.
+**Web app**
 
-There is a simple web app for testing the parser with ingredient sentences and showing the parsed output. To run the web app, run the command
+There is a simple web app for testing the parser, browsing the database, labelling entries, and running the basic model.
+
+To run the web app, follow the prior steps on `requirements-dev.txt`, and separately install [Node](https://nodejs.org/en/download), the JS runtime. Once globally installed on your machine, download your packages in the webtools directory with:
+
+```bash
+$ npm install
+```
+
+After package installs, run dev to start.
 
 ```bash
-$ flask --app webapp run
+$ npm run dev
 ```
 
-![Screen shot of web app](docs/source/_static/app-screenshot.png)
+*tl;dr — inside package.json, `flask` runs the base server, `sockets` runs the web sockets server, and `watch` runs vite build for the react/typescripe bundle — separate flask instances are required to accommodate better web socket behavior*
+
+![Screen shot of web parser](docs/source/_static/app.parser.screenshot.png)
+![Screen shot of web labeller](docs/source/_static/app.labeller.screenshot.png)
+![Screen shot of web trainer](docs/source/_static/app.trainer.screenshot.png)
+
+**Documentation**
+
+The dependencies for building the documentation are in the `requirements-doc.txt` file.
 
-This requires the development dependencies to be installed.
+**Contribution**
 
-The dependencies for building the documentation are in the ```requirements-doc.txt``` file.
+Please target the **develop** branch for pull requests. The main branch is used for stable releases and hotfixes only.
+
+There is a simple web app for testing the parser with ingredient sentences and showing the parsed output. To run the web app, run the command

docs/source/_static/app-screenshot.png renamed to docs/source/_static/app.archived.screenshot.png

@@ -128,16 +128,15 @@ Depending on the language, you may need a language specific :func:`tokenize <ing
 
 .. tip::
 
-    A web app has been developed to aid in the adding and labelling of training sentences. Run the command
+    A web app has been developed to aid in the adding and labelling of training sentences. If intending to add another language, you will need to adjust some of the web app code. Regardless, you can run these commands under the webtools directory to install the packages and run the web app.
 
     .. code:: bash
 
-        $ flask --app labeller run
+        $ npm install
+        $ npm run dev
 
     Then navigate to http://localhost:5000 in your browser.
 
-    You may need to tweak this to work with the correct database.
-
 1. Normalise
 ~~~~~~~~~~~~