tree: 1c4200e6c51f63d1390f6b6e6b8aba235669b6c5 [path history] [tgz]
  1. .husky/
  2. public/
  3. release-docs/
  4. src/
  5. .commitlintrc.ts
  6. .env
  7. .eslintignore
  8. .eslintrc.json
  9. .gitattributes
  10. .gitignore
  11. .prettierrc.ts
  12. index.html
  13. package-lock.json
  14. package.json
  15. pom.xml
  16. README.md
  17. README_CN.md
  18. tsconfig.json
  19. tsconfig.node.json
  20. vite.config.ts
linkis-web-next/README.md

English | 中文

Introduction

Linkis builds a layer of computation middleware between upper applications and underlying engines. By using standard interfaces such as REST/WS/JDBC provided by Linkis, the upper applications can easily access the underlying engines such as MySQL/Spark/Hive/Presto/Flink, etc., and achieve the intercommunication of user resources like unified variables, scripts, UDFs, functions and resource files at the same time.

Linkis Web provides a web management system to facilitate the management of user resources. However, the original Linkis Web project was developed using Vue2 and related technologies, but Vue2 has stopped maintenance and lacks community support. In addition, the file structure of the project itself is unclear, the module division is unreasonable, the component library used is also lacking maintenance, and the user experience of the interactive interface needs to be optimized.

As mentioned above, still iterating on the original project may leave various difficult problems. Therefore, we finally considered refactoring the project under the Linkis Web Next project, upgrading the core technology stack from Vue2 + Webpack to Vue3 + Vite, obtaining more community support, greatly improving the project starting and building rate, and solving various historical problems. Besides, using the internally maintained open-source UI component library Fes-Design, the problems can be promptly fed back and repaired.

The modules that have been refactored are as follows:

The modules that have been refactored
Login Page
Nav Bar
Side Bar
Global History Management
Parameter Config
Global Variables
Microservice Management
Resource Management
ECM Management
Base Data Management (SubModule Error Management)
Data Source Management (SubModule Data Source Access Permissions)
UDF Function Management (SubModule UDF User Management)

Sub-modules in Base Data Management, Data Source Management, and UDF Function Management will still need to be refactored in the future.

Start

# configure the project basic information in the `src/.env` firstly
cd linkis/linkis-web-next
npm install
npm run dev

# build 
npm run build

Contributing

Contributions are always welcomed, we need more contributors to build Linkis together. either code, or doc, or other supports that could help the community.
For code and documentation contributions, please follow the contribution guide.

Contact Us

  • Any questions or suggestions please kindly submit an issue.
  • By mail dev@linkis.apache.org
  • You can scan the QR code below to join our WeChat group to get more immediate response

Who is Using Linkis

We opened an issue [Who is Using Linkis] for users to feedback and record who is using Linkis.
Since the first release of Linkis in 2019, it has accumulated more than 700 trial companies and 1000+ sandbox trial users, which involving diverse industries, from finance, banking, tele-communication, to manufactory, internet companies and so on.