aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/developer
diff options
context:
space:
mode:
authorThomas Citharel <tcit@tcit.fr>2017-05-09 11:43:48 +0200
committerGitHub <noreply@github.com>2017-05-09 11:43:48 +0200
commitb28c5430efefa63d04d87404c99798e82d0427e4 (patch)
tree0bf158fb56120be6624fa26639a28beb84a6598e /docs/en/developer
parent43f81a62e93fb20c7af619a5132276706e989c62 (diff)
parentefac66cb56d650b863b64c9c4582589da6a2442a (diff)
downloadwallabag-b28c5430efefa63d04d87404c99798e82d0427e4.tar.gz
wallabag-b28c5430efefa63d04d87404c99798e82d0427e4.tar.zst
wallabag-b28c5430efefa63d04d87404c99798e82d0427e4.zip
Merge pull request #3022 from wallabag/webpack
Adds Webpack support and remove Grunt
Diffstat (limited to 'docs/en/developer')
-rw-r--r--docs/en/developer/front_end.rst33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/en/developer/front_end.rst b/docs/en/developer/front_end.rst
new file mode 100644
index 00000000..40f18a42
--- /dev/null
+++ b/docs/en/developer/front_end.rst
@@ -0,0 +1,33 @@
1Tips for front-end developers
2=============================
3
4Starting from version 2.3, wallabag uses webpack to bundle its assets.
5
6Dev mode
7--------
8
9If the server runs in dev mode, you need to run ``yarn run build:dev`` to generate the outputted javascript files for each theme. These are named ``%theme%.dev.js`` and are ignored by git. You need to relaunch ``yarn run build:dev`` for each change made to one of the assets files (js, css, pictures, fonts,...).
10
11Live reload
12-----------
13
14Webpack brings support for live reload, which means you don't need to regenerate the assets file for each change neither reload the page manually. Changes are applied automatically in the web page. Just set the ``use_webpack_dev_server`` setting to ``true`` in ``app/config/config.yml`` and run ``yarn run watch`` and you're good to go.
15
16.. note::
17
18 Don't forget to put back ``use_webpack_dev_server`` to ``false`` when not using the live reload feature.
19
20Production builds
21-----------------
22
23When you want to commit your changes, build them in production environment by using ``yarn run build:prod``. This will build all the assets needed for wallabag. To test that it properly works, you'll need to have a server in production mode, for instance with ``bin/console server:run -e=prod``.
24
25.. note::
26
27 Don't forget to generate production builds before committing !
28
29
30Code style
31----------
32
33Code style is checked by two tools : stylelint for (S)CSS and eslint for JS. ESlint config is based on the Airbnb base preset.