kyuubi/kyuubi-server/web-ui/README.md
liangbowen bb3e06a035
[KYUUBI #4312] [DOCS] Include **/README.md in markdown style check
### _Why are the changes needed?_

- Include `**/README.md` markdown files in spotless style check

### _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 #4312 from bowenliang123/reformat-readme.

Closes #4312

1fda1bdeb [Bowen Liang] Merge branch 'master' into reformat-readme
2ca8b4c81 [liangbowen] merge master
876f52a4c [liangbowen] include `**/README.md` in spotless style check

Lead-authored-by: liangbowen <liangbowen@gf.com.cn>
Co-authored-by: Bowen Liang <bowenliang@apache.org>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2023-02-14 02:23:32 +08:00

1.1 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

To do this you can change the VITE_APP_DEV_WEB_URL parameter variable as the service url in .env.development in the project root directory, such as http://127.0. 0.1:8090

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 7.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