From c3eac49bd52debdaca02e356233cfcb39b574df3 Mon Sep 17 00:00:00 2001 From: Richard Eckart de Castilho Date: Tue, 3 Oct 2023 13:25:18 +0200 Subject: [PATCH 1/2] Issue #150 - Include info on how to build in the README - Include info on building and testing into the README file - Remove deprecated webpack dev-server option preventing the dev-server from starting --- README.md | 9 +++++++++ web/webpack.config.js | 3 --- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8816d18..02f75de 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,15 @@ browser environments. See documentation on the website: +## How to build + +Build requirements are [Node.JS](https://nodejs.org/) (>= 16) and [yarn](https://yarnpkg.com) (1.x). 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 diff --git a/web/webpack.config.js b/web/webpack.config.js index 16ef2ef..198ea87 100644 --- a/web/webpack.config.js +++ b/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, - }, }; From 69335a5bfcf6bea2c6f018a2a82d73639376ec15 Mon Sep 17 00:00:00 2001 From: Richard Eckart de Castilho Date: Tue, 3 Oct 2023 13:28:38 +0200 Subject: [PATCH 2/2] Issue #150 - Include info on how to build in the README - Change the GitHub actions file to build on the current Node.js and the latest LTS version - Set minimum Node.js version to latest LTS version in package.json - Update README file accordingly --- .github/workflows/node.js.yml | 2 +- README.md | 4 ++-- package.json | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml index e978333..8cd188a 100644 --- a/.github/workflows/node.js.yml +++ b/.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: diff --git a/README.md b/README.md index 02f75de..5955680 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,8 @@ See documentation on the website: ## How to build -Build requirements are [Node.JS](https://nodejs.org/) (>= 16) and [yarn](https://yarnpkg.com) (1.x). All -other dependencies are automatically installed as part of the 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 diff --git a/package.json b/package.json index d7f97d1..30eb50c 100644 --- a/package.json +++ b/package.json @@ -80,7 +80,7 @@ "webpack-dev-server": "^4.15.1" }, "engines": { - "node": ">=16", + "node": ">=18", "yarn": "^1.5.0" } }