Add standalone application

.gitignore

@@ -7,9 +7,12 @@ node_modules/
 *.egg-info/
 .ipynb_checkpoints
 *.tsbuildinfo
-mercuryextension/labextension
+mercury_app/labextension
 # Version file is handled by hatchling
-mercuryextension/_version.py
+mercury_app/_version.py
+mercury_app/schemas
+mercury_app/static/*
+!mercury_app/static/logo
 
 # Integration tests
 ui-tests/test-results/
@@ -122,4 +125,5 @@ dmypy.json
 .DS_Store
 
 # Yarn cache
-.yarn/
+.yarn/*
+!.yarn/plugins

.prettierignore

@@ -0,0 +1,7 @@
+node_modules
+**/node_modules
+**/lib
+**/package.json
+!/package.json
+mercury_app
+app/build

.yarnrc.yml

@@ -1 +1,5 @@
 nodeLinker: node-modules
+
+plugins:
+  - path: .yarn/plugins/@yarnpkg/plugin-workspace-tools.cjs
+    spec: "@yarnpkg/plugin-workspace-tools"

CONTRIBUTING.md

@@ -1,26 +1,42 @@
-# mercuryextension
+# mercury_app
 
 [![Github Actions Status](https://github.com/mljar/mercury-extension/workflows/Build/badge.svg)](https://github.com/mljar/mercury-extension/actions/workflows/build.yml)
+
 Run notebooks as web apps with Mercury inside JupyterLab.
 
-## Requirements
+This repository contains two parts:
 
-- JupyterLab >= 4.0.0
+- A standalone application to display a Jupyter notebook as Mercury dashboard on top of a Jupyter Server
+- A JupyterLab extension to render a Jupyter notebook as Mercury dashboard; the extension is consumed by the application.
 
 ## Install
 
 To install the extension, execute:
 
 ```bash
-pip install mercuryextension
+pip install mercury_app
+```
+
+## Usage
+
+### Standalone application
+
+You can open a notebook with the standalone application by executing:
+
+```sh
+python -m mercury_app <path/to/notebook.ipynb>
 ```
 
+### JupyterLab extension
+
+The new renderer should be available right away.
+
 ## Uninstall
 
 To remove the extension, execute:
 
 ```bash
-pip uninstall mercuryextension
+pip uninstall mercury_app
 ```
 
 ## Contributing
@@ -35,7 +51,7 @@ The `jlpm` command is JupyterLab's pinned version of
 
 ```bash
 # Clone the repo to your local environment
-# Change directory to the mercuryextension directory
+# Change directory to the mercury_app directory
 # Install package in development mode
 pip install -e "."
 # Link your development version of the extension with JupyterLab
@@ -44,11 +60,42 @@ jupyter labextension develop . --overwrite
 jlpm build
 ```
 
+### Code structure
+
+- `app` folder: `mercury-app` NPM package containing the webpack configuration and start-up scripts for the standalone application
+- `packages/application` folder: `mercury-application` NPM package defining the specific element for the standalone application front-end.
+- `packages/lab` folder: `@mljar/mercury-extension` NPM package defining the JupyterLab extension.
+
+> [!NOTE]
+> The repository uses yarn _workspaces_ to handle multiple packages within a single repository. It requires a yarn
+> plugin that is installed by default in this repository (in `.yarn/plugins` folder). In case you need to
+> update it or install it again, you should refer to the [Yarn documentation](https://yarnpkg.com/cli/plugin/import).
+
+### Watch mode
+
+#### Standalone application
+
+You can watch the source directory of the stand alone application by running in two different terminals the following commands:
+
+```sh
+# Watch the application source and automatically rebuilding it when needed
+jlpm watch:app
+# Run the standalone app in another terminal
+python -m mercury_app example.ipynb
+```
+
+> [!NOTE]
+> Be sure to disable the cache on your web browser and to refresh
+> the standalone application web page each time you update the
+> code.
+
+#### JupyterLab extension
+
 You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
 
 ```bash
 # Watch the source directory in one terminal, automatically rebuilding when needed
-jlpm watch
+jlpm watch:lib
 # Run JupyterLab in another terminal
 jupyter lab
 ```
@@ -64,12 +111,12 @@ jupyter lab build --minimize=False
 ### Development uninstall
 
 ```bash
-pip uninstall mercuryextension
+pip uninstall mercury_app
 ```
 
 In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
 command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
-folder is located. Then you can remove the symlink named `@mljar/mercuryextension` within that folder.
+folder is located. Then you can remove the symlink named `@mljar/mercury-extension` within that folder.
 
 ### Testing the extension
 

README.md

@@ -9,14 +9,13 @@ Develop web apps from Python notebooks with Mercury directly in JupyterLab.
 To install the extension, execute:
 
 ```bash
-pip install mercuryextension
+pip install mercury_app
 ```
 
 ## Uninstall
 
 To remove the extension, execute:
 
 ```bash
-pip uninstall mercuryextension
+pip uninstall mercury_app
 ```
-

RELEASE.md

@@ -1,4 +1,4 @@
-# Making a new release of mercuryextension
+# Making a new release of mercury_app
 
 The extension can be published to `PyPI` and `npm` manually or using the [Jupyter Releaser](https://github.com/jupyter-server/jupyter_releaser).