Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/node.js.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
"webpack-dev-server": "^4.15.1"
},
"engines": {
"node": ">=16",
"node": ">=18",
"yarn": "^1.5.0"
}
}
3 changes: 0 additions & 3 deletions web/webpack.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,4 @@ module.exports = {
// Note this directory is imported by the annotator website
path: path.resolve(__dirname, 'dist'),
},
devServer: {
contentBase: false,
},
};