From 856f5d9a2c75e590a99b40933a46949d8d4e5375 Mon Sep 17 00:00:00 2001 From: silverwind Date: Sun, 12 Apr 2020 05:50:59 +0200 Subject: [PATCH] add 'make watch-frontend' and expand docs (#10931) * add 'make watch-frontend' and expand docs * add bindata note * add .PHONY Co-authored-by: guillep2k <18600385+guillep2k@users.noreply.github.com> --- doc/advanced/hacking-on-gitea.en-us.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/doc/advanced/hacking-on-gitea.en-us.md b/doc/advanced/hacking-on-gitea.en-us.md index 902bf847..31574d0a 100644 --- a/doc/advanced/hacking-on-gitea.en-us.md +++ b/doc/advanced/hacking-on-gitea.en-us.md @@ -128,10 +128,28 @@ make revive vet misspell-check ### Working on JS and CSS -Edit files in `web_src` and run the linter and build the files in `public`: +For simple changes, edit files in `web_src`, run the build and start the server to test: ```bash -make webpack +make build && ./gitea +``` + +For more involved changes use the `watch-frontend` task to continuously rebuild files when their sources change. The `bindata` tag must be absent to ensure the file system will be used for files in `public`. First, build and run the backend: + +```bash +make backend && ./gitea +``` + +With the backend running, open another terminal and run: + +```bash +make watch-frontend +``` + +Before committing, make sure the linters pass: + +```bash +make lint-frontend ``` Note: When working on frontend code, it is advisable to set `USE_SERVICE_WORKER` to `false` in `app.ini` which will prevent undesirable caching of frontend assets.