Merge pull request #151 from apache/feature/150-Include-info-on-how-t…

…o-build-in-the-README

Issue #150 - Include info on how to build in the README

.github/workflows/node.js.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18.x]
+        node-version: [18.x, 20.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:

README.md

@@ -8,6 +8,15 @@ browser environments.
 
 See documentation on the website: <https://annotator.apache.org/docs/>
 
+## How to build
+
+Build requirements are [Node.JS](https://nodejs.org/) (>= 16) and [yarn](https://yarnpkg.com) (>= 1.5.0).
+All other dependencies are automatically installed as part of the build.
+
+* `npm run build` -- builds the project
+* `npm test` -- runs the tests
+* `npm run start` -- starts the demo application
+
 ## Getting Involved
 
 * Join the [mailing list](http://mail-archives.apache.org/mod_mbox/incubator-annotator-dev/). Send an email to

package.json

@@ -80,7 +80,7 @@
     "webpack-dev-server": "^4.15.1"
   },
   "engines": {
-    "node": ">=16",
+    "node": ">=18",
     "yarn": "^1.5.0"
   }
 }

web/webpack.config.js

@@ -50,7 +50,4 @@ module.exports = {
     // Note this directory is imported by the annotator website
     path: path.resolve(__dirname, 'dist'),
   },
-  devServer: {
-    contentBase: false,
-  },
 };