Skip to content

Commit

Permalink
Merge pull request #17 from apache-superset/kristw--readme
Browse files Browse the repository at this point in the history
Update readme and remove unnecessary items from package.json
  • Loading branch information
kristw authored and zhaoyongjie committed Nov 26, 2021
1 parent 730d532 commit 68c8873
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 22 deletions.
11 changes: 5 additions & 6 deletions superset-frontend/temporary_superset_ui/superset-ui/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @superset-ui
# @superset-ui

[![Build Status](https://img.shields.io/travis/com/apache-superset/superset-ui.svg?style=flat-square
)](https://travis-ci.com/apache-superset/superset-ui)
Expand Down Expand Up @@ -44,22 +44,21 @@ superset-ui/
...
```

For easiest development
### Installation

1. clone this repo
2. install the root npm modules including lerna and yarn
3. have lerna install package dependencies and manage the symlinking between packages for you
2. have lerna install package dependencies and manage the symlinking between packages for you

```sh
git clone ...superset-ui && cd superset-ui
npm install
lerna bootstrap
npm run bootstrap
```

### Builds, linting, and testing

Each package defines its own build config, linting, and testing. You can have lerna run commands
across all packages using the syntax `lerna exec test` from the root `@superset/monorepo` root
across all packages using the syntax `npm run test` (or `npm run test:watch` for watch mode) from the root `@superset/monorepo` root
directory.

### Publishing
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Superset UI",
"private": true,
"scripts": {
"bootstrap": "lerna bootstrap",
"build": "yarn run build:cjs && yarn run build:esm",
"build:cjs": "NODE_ENV=production beemo babel ./src --out-dir lib/ --minify --workspaces=*",
"build:esm": "NODE_ENV=production beemo babel ./src --out-dir esm/ --esm --minify --workspaces=*",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,27 +25,11 @@
},
"homepage": "https://github.com/apache-superset/superset-ui#readme",
"devDependencies": {
"@data-ui/build-config": "^0.0.23",
"jest-mock-console": "^0.4.0"
},
"dependencies": {
"@babel/runtime": "^7.1.2",
"jed": "^1.1.1"
},
"beemo": {
"module": "@data-ui/build-config",
"drivers": [
"babel",
"eslint",
{
"driver": "jest",
"env": {
"NODE_ENV": "test"
}
},
"prettier"
]
},
"publishConfig": {
"access": "public"
}
Expand Down

0 comments on commit 68c8873

Please sign in to comment.