Add build widget and frontend in docs (#110)

Author: superstar54

README.md

@@ -39,14 +39,15 @@ To install the latest version from source, first clone the repository and then i
 
 ```console
 git clone https://github.com/superstar54/aiida-workgraph
-cd aiida-workgraph
-pip install -e .
-```
-In order to use the widget, you also need to run:
-```console
+pip install -e aiida-workgraph
+# build widget
 cd aiida_workgraph/widget/
 npm install
 npm run build
+# build web frontend
+cd ../../aiida_workgraph/web/frontend/
+npm install
+npm run build
 ```
 
 ## Documentation
@@ -118,20 +119,12 @@ pip install -e .[tests, pre-commit]
 pre-commit install
 ```
 
+### Widget
+See the [README.md](https://github.com/superstar54/aiida-workgraph/blob/main/aiida_workgraph/widget/README.md)
+
 ### Web app
 See the [README.md](https://github.com/superstar54/aiida-workgraph/blob/main/aiida_workgraph/web/README.md)
 
-### Build and publish
-Build package:
-```console
-pip install build
-python -m build
-```
-Upload to PyPI:
-```console
-pip install twine
-twine upload dist/*
-```
 
 ## License
 [MIT](http://opensource.org/licenses/MIT)

aiida_workgraph/widget/README.md

@@ -1,29 +1,14 @@
 # widget
 
-## Installation
-
-```sh
-pip install widget
-```
-
 ## Development installation
 
-Create a virtual environment and and install widget in *editable* mode with the
-optional development dependencies:
-
-```sh
-python -m venv .venv
-source .venv/bin/activate
-pip install -e ".[dev]"
-```
-
-You then need to install the JavaScript dependencies and run the development server.
+You need to install the JavaScript dependencies and run the development server.
 
 ```sh
 npm install
 npm run dev
 ```
 
-Open `example.ipynb` in JupyterLab, VS Code, or your favorite editor
+Then open JupyterLab, VS Code, or your favorite editor
 to start developing. Changes made in `js/` will be reflected
 in the notebook.

aiida_workgraph/widget/pyproject.toml

@@ -3,8 +3,11 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [project]
-name = "widget"
-version = "0.0.0"
+name = "node-graph-widget"
+version = "0.0.1"
+description = "Widget for node-graph"
+authors = [{name = "Xing Wang", email = "xingwang1991@gmail.com"}]
+readme = "README.md"
 dependencies = ["anywidget"]
 readme = "README.md"
 

docs/source/development/index.rst

@@ -4,9 +4,28 @@ Development
 
 This section contains information for developers.
 
+Pre-commit and Tests
+---------------------
+To contribute to this repository, please enable pre-commit to ensure that the code in commits conforms to the standards.
+
+.. code-block:: console
+
+    $ pip install -e .[tests, pre-commit]
+    $ pre-commit install
+
+Widget
+----------------
+See the `README.md <https://github.com/superstar54/aiida-workgraph/blob/main/aiida_workgraph/widget/README.md>`_.
+
+Web app
+----------------
+See the `README.md <https://github.com/superstar54/aiida-workgraph/blob/main/aiida_workgraph/web/README.md>`_.
+
+
+
 .. toctree::
    :maxdepth: 1
-   :caption: Contents:
+   :caption: Other Contents:
 
    data_serialization
    python_task

docs/source/installation.rst

@@ -35,6 +35,14 @@ To install the package from source, first clone the repository and then install
 
     $ git clone https://github.com/superstar54/aiida-workgraph
     $ pip install -e aiida-workgraph
+    $ # build widget
+    $ cd aiida_workgraph/widget/
+    $ npm install
+    $ npm run build
+    $ # build web frontend
+    $ cd ../../aiida_workgraph/web/frontend/
+    $ npm install
+    $ npm run build
 
 The ``-e`` flag will install the package in editable mode, meaning that changes to the source code will be automatically picked up.