Skip to content

chore: contributing guide #84

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

chore: contributing guide #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0dd8c83
chore: contributing guide
YuJianghao Sep 5, 2023
4d34a9a
fix: cross env
YuJianghao Sep 5, 2023
6d5fddc
chore: repo url
YuJianghao Sep 5, 2023
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
34 changes: 34 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
```
12 changes: 8 additions & 4 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -31,14 +34,15 @@
"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",
"less-loader": "^4.1.0",
"style-loader": "^0.20.3",
"webpack": "^4.5.0",
"webpack-cli": "^4.9.1",
"ykit": "^0.8.13",
"ykit-config-antd": "^2"
}
}