diff --git a/create-umi/README.md b/create-umi/README.md new file mode 100644 index 0000000000000000000000000000000000000000..14c3286ac4d2e1ecb2c90e8a1273e07bd06956d2 --- /dev/null +++ b/create-umi/README.md @@ -0,0 +1,56 @@ +# Ant Design Pro + +This project is initialized with [Ant Design Pro](https://pro.ant.design). Follow is the quick guide for how to use. + +## Environment Prepare + +Install `node_modules`: +```bash +npm install +``` + +or + +```bash +yarn +``` + +## Provided Scripts + +Ant Design Pro provides some useful script to help you quick start and build with web project, code style check and test. + +Scripts provided in `package.json`. It's safe to modify or add additional script: + +### Start project + +```bash +npm start +``` + +### Build project + +```bash +npm run build +``` + +### Check code style + +```bash +npm run lint +``` + +You can also use script to auto fix some lint error: + +```bash +npm run lint:fix +``` + +### Test code + +```bash +npm test +``` + +## More + +You can view full document on our [official website](https://pro.ant.design). And welcome any feedback in our [github](https://github.com/ant-design/ant-design-pro). \ No newline at end of file diff --git a/create-umi/package.json b/create-umi/package.json new file mode 100644 index 0000000000000000000000000000000000000000..813bef862cd09739ca9e69a980314e3c73ecf9c5 --- /dev/null +++ b/create-umi/package.json @@ -0,0 +1,131 @@ +{ + "name": "ant-design-pro", + "version": "4.0.0", + "private": true, + "description": "An out-of-box UI solution for enterprise applications", + "scripts": { + "analyze": "cross-env ANALYZE=1 umi build", + "build": "umi build", + "generateMock": "node ./scripts/generateMock", + "lint": "npm run lint:js && npm run lint:ts && npm run lint:style && npm run lint:prettier", + "lint-staged": "lint-staged", + "lint-staged:js": "eslint --ext .js", + "lint-staged:ts": "tslint", + "lint:fix": "eslint --fix --ext .js src tests && npm run lint:style && npm run tslint:fix", + "lint:js": "eslint --ext .js src tests", + "lint:prettier": "check-prettier lint", + "lint:style": "stylelint --fix 'src/**/*.less' --syntax less", + "lint:ts": "tslint -p . -c tslint.yml", + "prettier": " check-prettier write", + "start": "umi dev", + "start:no-mock": "cross-env MOCK=none umi dev", + "test": "umi test", + "test:all": "node ./tests/run-tests.js", + "test:component": "umi test ./src/components", + "tslint:fix": "tslint --fix 'src/**/*.ts*'" + }, + "husky": { + "hooks": { + "pre-commit": "npm run lint-staged" + } + }, + "lint-staged": { + "**/*.less": "stylelint --syntax less", + "**/*.{js,jsx}": "npm run lint-staged:js", + "**/*.{js,ts,tsx,md,json,jsx,less}": [ "npm run prettier", "git add" ], + "**/*.{ts,tsx}": "npm run lint-staged:ts" + }, + "browserslist": [ "> 1%", "last 2 versions", "not ie <= 10" ], + "dependencies": { + "@ant-design/pro-layout": "^4.2.0", + "@antv/data-set": "^0.10.1", + "antd": "^3.16.1", + "bizcharts": "^3.5.3-beta.0", + "bizcharts-plugin-slider": "^2.1.1-beta.1", + "classnames": "^2.2.6", + "dva": "^2.4.0", + "lodash": "^4.17.10", + "lodash-decorators": "^6.0.0", + "memoize-one": "^5.0.0", + "moment": "^2.22.2", + "numeral": "^2.0.6", + "omit.js": "^1.0.0", + "path-to-regexp": "^2.4.0", + "qs": "^6.7.0", + "rc-animate": "^2.4.4", + "react": "^16.8.5", + "react-container-query": "^0.11.0", + "react-copy-to-clipboard": "^5.0.1", + "react-document-title": "^2.0.3", + "react-dom": "^16.7.0", + "react-fittext": "^1.0.0", + "react-media": "^1.9.2", + "react-media-hook2": "^1.0.2" + }, + "devDependencies": { + "@types/classnames": "^2.2.7", + "@types/history": "^4.7.2", + "@types/lodash": "^4.14.123", + "@types/react": "^16.8.1", + "@types/react-document-title": "^2.0.3", + "@types/react-dom": "^16.0.11", + "antd-pro-merge-less": "^1.0.0", + "antd-theme-webpack-plugin": "^1.2.0", + "babel-eslint": "^10.0.1", + "chalk": "^2.4.2", + "check-prettier": "^1.0.1", + "cross-env": "^5.2.0", + "cross-port-killer": "^1.0.1", + "enzyme": "^3.9.0", + "eslint": "^5.13.0", + "eslint-config-airbnb": "^17.1.0", + "eslint-config-prettier": "^4.1.0", + "eslint-plugin-babel": "^5.3.0", + "eslint-plugin-compat": "^2.6.3", + "eslint-plugin-import": "^2.16.0", + "eslint-plugin-jsx-a11y": "^6.2.1", + "eslint-plugin-markdown": "^1.0.0", + "eslint-plugin-react": "^7.12.4", + "express": "^4.16.4", + "gh-pages": "^2.0.1", + "husky": "^2.2.0", + "jest-puppeteer": "^4.1.0", + "jsdom-global": "^3.0.2", + "less": "^3.9.0", + "lint-staged": "^8.1.1", + "merge-umi-mock-data": "^1.0.4", + "mockjs": "^1.0.1-beta3", + "prettier": "^1.17.0", + "serverless-http": "^2.0.1", + "slash2": "^2.0.0", + "stylelint": "^9.10.1", + "stylelint-config-css-modules": "^1.3.0", + "stylelint-config-prettier": "^5.0.0", + "stylelint-config-rational-order": "^0.1.0", + "stylelint-config-standard": "^18.2.0", + "stylelint-declaration-block-no-ignored-properties": "^2.1.0", + "stylelint-order": "^2.0.0", + "tslint": "^5.12.1", + "tslint-config-prettier": "^1.17.0", + "tslint-eslint-rules": "^5.4.0", + "tslint-react": "^3.6.0", + "umi": "^2.7.0-beta.2", + "umi-plugin-ga": "^1.1.3", + "umi-plugin-pro-block": "^1.3.0", + "umi-plugin-react": "^1.8.0-beta.1", + "umi-request": "^1.0.0" + }, + "optionalDependencies": { + "puppeteer": "^1.12.1" + }, + "engines": { + "node": ">=10.0.0" + }, + "checkFiles": [ + "src/**/*.js*", + "src/**/*.ts*", + "src/**/*.less", + "config/**/*.js*", + "scripts/**/*.js" + ] +} diff --git a/package.json b/package.json index 95813713243f5a5ed2627287c69c1a599844058a..adcc39b1c2ccbc5b1979e844f0ebb55ef854da7c 100644 --- a/package.json +++ b/package.json @@ -140,6 +140,10 @@ "scripts/**/*.js" ], "create-umi": { + "copy": [ + ["create-umi/README.md", "README.md"], + ["create-umi/package.json", "package.json"] + ], "ignore": [ ".dockerignore", ".git", @@ -150,10 +154,11 @@ "lambda", "LICENSE", "netlify.toml", - "*.md", + "README.*.md", "scripts", "azure-pipelines.yml", - "docker" + "docker", + "create-umi" ] } }