diff options
author | Jonathan Treffler <mail@jonathan-treffler.de> | 2020-08-07 12:43:52 +0200 |
---|---|---|
committer | Simon Spannagel <simonspa@kth.se> | 2021-12-16 20:17:31 +0100 |
commit | 676ac7bd2f23eb9b3d56ead782678e1c5af1e42b (patch) | |
tree | 8b3be5bcb900bd315f7d744569cd778887cc0000 /src/README.md | |
parent | e11573e64736f838b05b9af84b0a26d13c1aac3f (diff) |
updated js programming readme
Signed-off-by: Jonathan Treffler <mail@jonathan-treffler.de>
Diffstat (limited to 'src/README.md')
-rw-r--r-- | src/README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/src/README.md b/src/README.md new file mode 100644 index 000000000..5edd4eb7c --- /dev/null +++ b/src/README.md @@ -0,0 +1,31 @@ +# JavaScript Development +JavaScript is built and minified using webpack. + +Therefore you need to install **Node.js 6+ and npm**. + +Then install the local dependencies by running: + + npm install + +## Tasks +The following tasks are available: + +* **Build the JavaScript**: + + npm run build + +* **Build the JavaScript in Dev Mode**: + + npm run build + +* **Watch for changes and build JavaScript**: + + npm run watch + +* **Run JavaScript unit tests**: + + npm run karma + +* **Watch for changes and run JavaScript unit tests**: + + npm run watch-karma |