aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorVincent Peugnet <vincent-peugnet@riseup.net>2021-03-04 18:36:59 +0100
committerGitHub <noreply@github.com>2021-03-04 18:36:59 +0100
commit68b526ca04dfa56d608debb7ce29a7c75cff8975 (patch)
tree69f929a128b6fe609639dbb213c455858c9e3d0a /README.md
parentfd45c302c76be4d293ff9f166ef063a10d88db87 (diff)
parent09d5322c9a500731d31fef697e247db709b15290 (diff)
downloadwcms-68b526ca04dfa56d608debb7ce29a7c75cff8975.tar.gz
wcms-68b526ca04dfa56d608debb7ce29a7c75cff8975.zip
Merge pull request #132 from n-peugnet/feat/dev-server
feat: add make dev target to run a dev server
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/README.md b/README.md
index 4d0786e..d81d1f6 100644
--- a/README.md
+++ b/README.md
@@ -114,7 +114,7 @@ Install from sources
make vendor
-3. _Optionnally_ install and build JS dependencies to get UI enhancements.
+3. _Optionally_ install and build JS dependencies to get UI enhancements.
make build
@@ -136,6 +136,10 @@ The build environment can be set either for each `make` command by changing it i
PHP development
---------------
+You can easily run a dev server using the `serve` target:
+
+ make serve
+
There is an error reporting debug mode using [Whoops](https://github.com/filp/whoops). It can be enabled by setting the value of `debug` in `config.json` to one of [editors supported by Whoops](https://github.com/filp/whoops/blob/master/docs/Open%20Files%20In%20An%20Editor.md).
JS development
@@ -145,6 +149,10 @@ While developing JS code it is useful to run webpack in watch mode so that the b
make watch
+To run both the php dev server and webpack in watch mode, it is possible to run:
+
+ make dev
+
Run checks
---------