Skip to content

Commit

Permalink
Update tools used for PoWA-Web development
Browse files Browse the repository at this point in the history
  • Loading branch information
pirlgon committed Jul 10, 2024
1 parent 9c8e44f commit 04d4b09
Showing 1 changed file with 20 additions and 15 deletions.
35 changes: 20 additions & 15 deletions docs/components/powa-web/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,32 @@ Clone the repository:
.. code:: bash
git clone https://github.com/powa-team/powa-web/
cd powa/
make && sudo make install
cd powa-web/
To run the application, use run_powa.py, which will run powa in debug mode.
That means the javascript files will not be minified, and will not be compiled
into one giant source file.
Then, create a Python3 virtualenv and install the project dependencies:

.. code:: bash
python3 -m venv .venv --upgrade-deps
. .venv/bin/activate
pip install -r requirements.txt
In case you want to contribute on the styles, first install the NodeJS dev dependencies:

CSS files are generated using `sass <https://sass-lang.com/>`.
Javascript files are splitted into AMD modules, which are managed by `requirejs
<https://requirejs.org/>` and compiled using `grunt <https://gruntjs.com/>`.
.. code:: bash
These projects depend on NodeJS, and NPM, its package manager, so make sure you are able to install them on your
distribution.
npm ci
Install the development dependencies:
After installing the dependencies, you can start the ViteJS development server with:

.. code:: bash
npm install -g grunt-cli
npm install .
npm run dev
This command launches a local server at http://localhost:5173 with hot module replacement,
enabling real-time updates as you modify the project files.

To run the application, use ``run_powa.py``, which will run powa in debug mode.

Then, you can run ``grunt`` to update only the css files, or regenerate optimized
javascript builds with ``grunt dist``.
This version uses `ViteJS` and `Vue 3` for a more integrated and performant
front-end development experience.

0 comments on commit 04d4b09

Please sign in to comment.