From 7b2086b668b0996032266d7b9f74eb40c846fc3e Mon Sep 17 00:00:00 2001 From: Bill Church Date: Thu, 13 May 2021 05:30:13 -0400 Subject: [PATCH] docs: create building doc --- BUILDING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 BUILDING.md diff --git a/BUILDING.md b/BUILDING.md new file mode 100644 index 0000000..29d452c --- /dev/null +++ b/BUILDING.md @@ -0,0 +1,13 @@ +# Buliding + +To rebuild the client files, you need at least Node v10. + +The source of the client files are located in `./app/client/source` + +`npm run build` will compile the source files there into `./app/client/public/`. This directory is considered to be volitile and is deleted every time `npm run build` is invoked. + +WebPack is used for building and the configuration is located in `./app/scripts` + +If one wishes to make changes to the javascript, the html, or the css it should be done in `./app/client/source` and then complied using `npm run build` + +For development purposes, you may also utilize `npm run builddev` which will not minimize the source and allow you to more easily troubleshoot while making customizations.