From 40a8ca547b7a2af896d2ec180a4c70e3f213ea2b Mon Sep 17 00:00:00 2001 From: bkapustik <82807109+bkapustik@users.noreply.github.com> Date: Mon, 7 Oct 2024 11:16:24 +0200 Subject: [PATCH] feat(docs): client module development instructions --- docs/Contributing-Setup.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/Contributing-Setup.md b/docs/Contributing-Setup.md index ffb6ef1..05f883b 100644 --- a/docs/Contributing-Setup.md +++ b/docs/Contributing-Setup.md @@ -57,6 +57,17 @@ To run the example project Admin customization in development mode, add the foll } ``` +The Xperience web application requests client modules from a webpack dev server that runs parallel to the Xperience application. + +Changes to client code are immediately integrated and don’t require a restart or rebuild of the web application. + +Before you start developing, the webpack server needs to be manually started by running + +```bash +npm run start +``` +from the root of the module folder, in our case in the `/src/Kentico.Xperience.Lucene.Admin/Client` folder. + ## Development Workflow ### Prepare your Git branch and commits