@@ -17,27 +17,45 @@ Clone the repository:
1717.. code :: bash
1818
1919 git clone https://github.com/powa-team/powa-web/
20- cd powa/
21- make && sudo make install
20+ cd powa-web/
2221
23- To run the application, use run_powa.py, which will run powa in debug mode.
24- That means the javascript files will not be minified, and will not be compiled
25- into one giant source file.
22+ Then, create a Python3 virtualenv and install the project dependencies:
2623
24+ .. code :: bash
25+
26+ python3 -m venv .venv --upgrade-deps
27+ . .venv/bin/activate
28+ pip install -r requirements.txt
29+
30+ In case you want to contribute on the styles, first install the NodeJS dev dependencies:
2731
28- CSS files are generated using `sass <https://sass-lang.com/> `.
29- Javascript files are splitted into AMD modules, which are managed by `requirejs
30- <https://requirejs.org/> ` and compiled using `grunt <https://gruntjs.com/> `.
32+ .. code :: bash
3133
32- These projects depend on NodeJS, and NPM, its package manager, so make sure you are able to install them on your
33- distribution.
34+ npm ci
3435
35- Install the development dependencies :
36+ After installing the dependencies, you can start the ViteJS development server with :
3637
3738.. code :: bash
3839
39- npm install -g grunt-cli
40- npm install .
40+ npm run dev
41+
42+ This command launches a local server at http://localhost:5173 with hot module replacement,
43+ enabling real-time updates as you modify the project files.
44+
45+ To run the application, use ``run_powa.py `` in the PoWA-Web project root, which will run PoWa in debug mode.
46+
47+ .. code :: bash
48+
49+ cd powa-web/
50+ ./run_powa.py
51+ [I 240718 09:13:07 run_powa:11] Starting powa-web on http://127.0.0.1:8888/
52+
53+ If you don't already have a running instance of PoWA, you can easily deploy an environment
54+ for PoWa web development using `powa-podman <https://github.com/powa-team/powa-podman/tree/master/dev >`_.
55+ This project provides container images and compose files in its dev directory.
56+
57+ Once you have cloned it, you can start the PoWA stack and specify your PoWA-Web development location.
4158
42- Then, you can run ``grunt `` to update only the css files, or regenerate optimized
43- javascript builds with ``grunt dist ``.
59+ PoWA-Web uses `ViteJS ` and `Vue 3 ` for a more integrated and performant
60+ front-end development experience.
61+
0 commit comments