Add npm script to run http-server #969 (#971)

* Signed off by @ankur12-1610
kiwix · Mar 8, 2023 · 74690b8 · 74690b8
1 parent 6792f81
commit 74690b8
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -13,8 +13,7 @@ Please follow these guidelines when contributing:
   supported via a polyfill;
 - Do not prettify code you are not working on;
 - You must test your code yourself before asking for review, like this:
-  - set up a local Web server (we recommend Node/NPM's [http-server](https://www.npmjs.com/package/http-server));
-  - serve the root directory of the repository (e.g. `http-server .`);
+  - set up a local Web server: we recommend Node/NPM's [http-server](https://www.npmjs.com/package/http-server)), which you can launch by running `npm run serve` in the root of this repository;
   - in a browser, navigate to the URL of the main `index.html` (e.g. http://localhost:8080/www/index.html);
   - manually test your fix in at least Firefox and Chromium (Edge or Chrome), ideally also in IE11 or in "IE Mode" in Edge;
   - be sure to test your fix in both "JQuery" mode and "Service Worker" mode (see Configuration);

diff --git a/package.json b/package.json
@@ -1,6 +1,7 @@
 {
   "private": true,
   "scripts": {
+    "serve": "http-server .",
     "test": "npm run test-unit-local",
     "test-unit-local": "karma start tests/karma.conf.local.js",
     "test-unit-firefox": "karma start tests/karma.conf.local.js --browsers FirefoxHeadless",