@@ -118,6 +118,26 @@ Then, you should be able to activate your development environment with:
118118
119119 hatch shell
120120
121+ From within the shell, to install the projects in this repository, you should then run:
122+
123+ .. code-block :: bash
124+
125+ invoke env
126+
127+ Project Structure
128+ -----------------
129+
130+ This repository is set up to be able to manage many applications and libraries written
131+ in a variety of languages. All projects can be found under the ``src `` directory:
132+
133+ - ``src/py/{project} `` - Python packages
134+ - ``src/js/app `` - ReactPy's built-in JS client
135+ - ``src/js/packages/{project} `` - JS packages
136+
137+ At the root of the repository is a ``pyproject.toml `` file that contains scripts and
138+ their respective dependencies for managing all other projects. Most of these global
139+ scripts can be run via ``hatch run ... `` however, for more complex scripting tasks, we
140+ rely on Invoke _. Scripts implements with Invoke can be found in ``tasks.py ``.
121141
122142Running The Tests
123143-----------------
@@ -302,12 +322,14 @@ you should refer to their respective documentation in the links below:
302322 Jupyter
303323- `reactpy-dash <https://github.com/reactive-python/reactpy-dash >`__ - ReactPy integration for Plotly
304324 Dash
305- - `django- reactpy <https://github.com/reactive-python/django- reactpy >`__ - ReactPy integration for
325+ - `reactpy-django <https://github.com/reactive-python/reactpy-django >`__ - ReactPy integration for
306326 Django
307327
308328.. Links
309329.. =====
310330
331+ .. _Hatch : https://hatch.pypa.io/
332+ .. _Invoke : https://www.pyinvoke.org/
311333.. _Google Chrome : https://www.google.com/chrome/
312334.. _Docker : https://docs.docker.com/get-docker/
313335.. _Git : https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
0 commit comments