diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b4c570d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,34 @@ +# CONTRIBUTING + +## Prerequisites + +- Node.js: v14.x.x +- Package manager: npm + +## Install + +```bash +npm install +``` + +## Develop + +Start dev server. + +```bash +npm run start +``` + +Then open `http://127.0.0.1:8082/index.html` in your browser. + +Resources will be rebuild when files changed. Refresh page to see updates, HMR not supported. + +## Build + +```bash +# Build Package +npm run build + +# Build Demo Page +npm run demo +``` \ No newline at end of file diff --git a/package.json b/package.json index 3fe0e34..cbb3a03 100644 --- a/package.json +++ b/package.json @@ -3,11 +3,14 @@ "version": "2.0.0", "description": "jsonschema editor", "main": "package/index.js", - "license": "MIC", + "repository": { + "url": "https://github.com/Open-Federation/json-schema-editor-visual" + }, + "license": "MIT", "scripts": { "start": "ykit s -p 8082", - "demo": "NODE_ENV=production ykit pack -m", - "build": "NODE_ENV=production webpack" + "demo": "cross-env NODE_ENV=production ykit pack -m", + "build": "cross-env NODE_ENV=production webpack" }, "dependencies": { "@ant-design/icons": "^4.2.1", @@ -31,7 +34,7 @@ "babel-preset-env": "^1.6.1", "babel-preset-react": "^6.24.1", "babel-preset-react-app": "^3.1.0", - "cross-env": "^5.1.1", + "cross-env": "^5.2.1", "css-loader": "^0.28.11", "extract-text-webpack-plugin": "^4.0.0-beta.0", "less": "^2.7.2", @@ -39,6 +42,7 @@ "style-loader": "^0.20.3", "webpack": "^4.5.0", "webpack-cli": "^4.9.1", + "ykit": "^0.8.13", "ykit-config-antd": "^2" } }