kyuubi/kyuubi-server/web-ui/README.md
liangbowen e4fe4814ec
[KYUUBI #4783] Use pnpm v8 and update pnpm lockfile to v6 schema
### _Why are the changes needed?_

- v8 is now the stable version of pnpm
- lockfile v6 is used by default since pnpm v8.0, which improves the readability of the lockfile by removing hashes from package IDs and more resistant to git merge conflicts (https://github.com/pnpm/pnpm/releases/tag/v8.0.0)
- pnpm 8 supports nodejs 16 and 18 (https://pnpm.io/installation#compatibility)

### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [ ] Add screenshots for manual tests if appropriate

- [x] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #4783 from bowenliang123/pnpm8.

Closes #4783

8b3db3820 [liangbowen] use pnpm v8 and update lock file to v6

Authored-by: liangbowen <liangbowen@gf.com.cn>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2023-05-03 18:39:22 +08:00

1.5 KiB

Kyuubi Web UI

Start Using

For the best experience, we recommend using node 16.x.x. You can learn how to install the corresponding version from its official website.

Install Dependencies

npm install

Development Project

Notice:

Before you start the Web UI project, please make sure the Kyuubi server has been started.

Kyuubi Web UI will proxy the requests to Kyuubi server, with the default endpoint path tohttp://localhost:10099. Modify VITE_APP_DEV_WEB_URL in .env.development for customizing targeted endpoint path.

Why proxy to http://localhost:10099

Currently kyuubi server binds on http://0.0.0.0:10099 in case your are running kyuubi server in MacOS or Windows(If in linux, you should config kyuubi server kyuubi.frontend.rest.bind.host=0.0.0.0, or change VITE_APP_DEV_WEB_URL in .env.development).

npm run dev

Build Project

npm run build

Code Format

Usually after you modify the code, you need to perform code formatting operations to ensure that the code in the project is the same style.

npm run prettier

Recommend

If you want to save disk space and boost installation speed, we recommend using pnpm 8.x.x to instead of npm. You can learn how to install the corresponding version from its official website.

# Install Dependencies
pnpm install

# Development Project
pnpm run dev

# Build Project
pnpm run build

# Code Format
pnpm run prettier