Skip to content

Commit 74db9a1

Browse files
authored
Merge pull request #167 from EdurtIO/develop
Released for 1.17.0
2 parents 2355406 + bade65d commit 74db9a1

File tree

331 files changed

+1501
-22232
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

331 files changed

+1501
-22232
lines changed

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,4 +125,4 @@ enforcement ladder](https://github.com/mozilla/diversity).
125125

126126
For answers to common questions about this code of conduct, see the FAQ at
127127
https://www.contributor-covenant.org/faq. Translations are available at
128-
https://www.contributor-covenant.org/translations.
128+
https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## Contributing
2+
3+
[fork]: /fork
4+
[pr]: /compare
5+
[code-of-conduct]: CODE_OF_CONDUCT.md
6+
7+
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
8+
9+
Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
10+
11+
## Issues and PRs
12+
13+
If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We'd love all and any contributions. If you have questions, too, we'd love to hear them.
14+
15+
We'd also love PRs. If you're thinking of a large PR, we advise opening up an issue first to talk about it, though! Look at the links below if you're not sure how to open a PR.
16+
17+
## Submitting a pull request
18+
19+
1. [Fork][fork] and clone the repository.
20+
1. Configure and install the dependencies: `npm install`.
21+
1. Make sure the tests pass on your machine: `npm test`, note: these tests also apply the linter, so there's no need to lint separately.
22+
1. Create a new branch: `git checkout -b my-branch-name`.
23+
1. Make your change, add tests, and make sure the tests still pass.
24+
1. Push to your fork and [submit a pull request][pr].
25+
1. Pat your self on the back and wait for your pull request to be reviewed and merged.
26+
27+
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
28+
29+
- Write and update tests.
30+
- Keep your changes as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
31+
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
32+
33+
Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocked you.
34+
35+
## Resources
36+
37+
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
38+
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
39+
- [GitHub Help](https://help.github.com)

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright [2021] [incubator-dbm of copyright EdurtIO]
189+
Copyright [2021] [dbm of copyright EdurtIO]
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.

README.md

Lines changed: 48 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,20 @@
33
<a href="https://github.com/EdurtIO/incubator-dbm">
44
<img src="src/shared/assets/icons/favicon.png" alt="Logo" width="120px" height="120px">
55
</a>
6-
<h2 align="center">DBM</h3>
7-
<p align="center">
8-
An awesome database management tool specified for <a href='https://clickhouse.tech'>ClickHouse</a>. For more information: <a href='https://dbm.incubator.edurt.io'>https://dbm.incubator.edurt.io</a>.
9-
<br />
10-
</p>
116
</p>
127

13-
---
14-
15-
Contributors:
8+
[![Typing SVG](https://readme-typing-svg.herokuapp.com?size=25&width=750&lines=DBM+is+a+open+source+database+management+system.)](https://git.io/typing-svg)
169

1710
![GitHub Contributors Image](https://contrib.rocks/image?repo=EdurtIO/dbm)
1811

19-
Basic:
12+
**Documentation**
13+
14+
[中文](http://dbm-zh.edurt.io/) <br />
15+
[English](https://dbm.edurt.io/)
16+
17+
## Overview
18+
19+
---
2020

2121
![](https://visitor-badge.glitch.me/badge?page_id=dbm)
2222
![version](https://img.shields.io/github/v/release/EdurtIO/dbm.svg)
@@ -31,39 +31,57 @@ Basic:
3131
![GitHub contributors](https://img.shields.io/github/contributors-anon/EdurtIO/dbm?style=flat-square)
3232
![GitHub last commit](https://img.shields.io/github/last-commit/EdurtIO/dbm?style=flat-square)
3333

34-
Workflow:
34+
## Workflow
3535

36-
[![Test by push](https://github.com/EdurtIO/dbm/actions/workflows/push-compile-test.yml/badge.svg)](https://github.com/EdurtIO/dbm/actions/workflows/push-compile-test.yml)
36+
---
3737

38-
[![Publish New Release](https://github.com/EdurtIO/dbm/actions/workflows/publish-release.yml/badge.svg)](https://github.com/EdurtIO/dbm/actions/workflows/upload-to-release.yml)
38+
**GitHub Actions workflow**
3939

40+
[![Test by push](https://github.com/EdurtIO/dbm/actions/workflows/push-compile-test.yml/badge.svg)](https://github.com/EdurtIO/dbm/actions/workflows/push-compile-test.yml)
41+
[![Publish New Release](https://github.com/EdurtIO/dbm/actions/workflows/publish-release.yml/badge.svg)](https://github.com/EdurtIO/dbm/actions/workflows/upload-to-release.yml)
4042
[![Publish docs via GitHub Pages](https://github.com/EdurtIO/dbm/actions/workflows/publish-docs.yml/badge.svg)](https://github.com/EdurtIO/dbm/actions/workflows/publish-docs.yml)
4143

42-
Development:
44+
**Development workflow**
4345

4446
[![codebeat badge](https://codebeat.co/badges/a291d700-2d4b-435f-aa70-468bd1800d19)](https://codebeat.co/projects/github-com-edurtio-incubator-dbm-master)
4547
[![With Electron](https://img.shields.io/badge/with-electron-blue.svg)](https://electronjs.org/)
4648
[![With Angular](https://img.shields.io/badge/with-angular-blue.svg)](https://angular.io/)
4749
[![With Jetbrains](https://img.shields.io/badge/with-Jetbrains-blue.svg)](https://www.jetbrains.com/)
4850

49-
GitHub:
51+
## Mirror
52+
53+
---
54+
55+
**GitHub**
5056

5157
[![GitHub stars](https://img.shields.io/github/stars/EdurtIO/incubator-dbm?style=for-the-badge)](https://github.com/EdurtIO/incubator-dbm/stargazers)
5258
[![GitHub license](https://img.shields.io/github/license/EdurtIO/incubator-dbm?style=for-the-badge)](https://github.com/EdurtIO/incubator-dbm/blob/master/LICENSE)
5359
[![GitHub issues](https://img.shields.io/github/issues/EdurtIO/incubator-dbm?style=for-the-badge)](https://github.com/EdurtIO/incubator-dbm/issues)
5460
[![GitHub forks](https://img.shields.io/github/forks/EdurtIO/incubator-dbm?style=for-the-badge)](https://github.com/EdurtIO/incubator-dbm/network)
5561

56-
## Join Us
62+
**Gitee**
5763

58-
Open the DingTalk software and scan the following QR code to join
64+
[![star](https://gitee.com/EdurtIO/dbm/badge/star.svg?theme=dark)](https://gitee.com/EdurtIO/dbm/stargazers)
65+
[![fork](https://gitee.com/EdurtIO/dbm/badge/fork.svg?theme=white)](https://gitee.com/EdurtIO/dbm/members)
66+
[![Fork me on Gitee](https://gitee.com/EdurtIO/dbm/widgets/widget_3.svg)](https://gitee.com/EdurtIO/dbm)
5967

60-
<img src="src/shared/common/dingtalk.jpg" width="200px" height="250px"></img>
68+
## Supported Databases
6169

62-
## Thank you
70+
---
6371

64-
- [Jetbrains](https://www.jetbrains.com/)
72+
DBM can query data from any SQL-speaking datastore or data engine (ClickHouse and more).
73+
74+
Here are some of the major database solutions that are supported:
75+
76+
<p align="center">
77+
<img src="./src/shared/assets/integrate/clickhouse.png" alt="clickhouse" border="0" width="133" height="34" />
78+
<img src="./src/shared/assets/integrate/trino.png" alt="trino" border="0" width="46" height="46"/>
79+
<img src="./src/shared/assets/integrate/presto.png" alt="presto" border="0" width="152" height="46"/>
80+
</p>
81+
82+
## Features
6583

66-
## :rocket: Features
84+
---
6785

6886
- Support query history (pagination, clear all, etc.)
6987
- Support selected sql clauses query
@@ -86,52 +104,22 @@ Open the DingTalk software and scan the following QR code to join
86104
- Support monitor (processor, connection, query)
87105
- Support migrate data
88106

89-
## :laughing: Download
90-
91-
- [Windows](https://github.com/EdurtIO/incubator-dbm/releases/download/1.4.0/dbm-win.zip)
92-
- [Mac](https://github.com/EdurtIO/incubator-dbm/releases/download/1.4.0/dbm-mac.tar.gz)
93-
94-
## :gear: Installation
95-
96-
macOS and Windows
97-
98-
- Download zip from [here](https://github.com/EdurtIO/incubator-dbm/releases).
99-
- Unzip the archive, and install to macOS Applications.
100-
101-
Other platforms
102-
103-
- Unsupported temporarily. You can install the DBM by [building from source](#hammer_and_wrench-build-from-source).
104-
105-
Install other versions?
106-
107-
- Go ahead to [Github Release](https://github.com/EdurtIO/incubator-dbm/releases) for all releases.
108-
109-
## :hammer_and_wrench: Build from source
110-
111-
1. Install dependencies
107+
## Join Us
112108

113-
```bash
114-
npm install -g node-sass
109+
---
115110

116-
yarn install
117-
```
111+
Open the DingTalk software and scan the following QR code to join
118112

119-
2. Build electron app for production
113+
<img src="src/shared/common/dingtalk.jpg" width="200px" height="250px"></img>
120114

121-
```bash
122-
yarn run build
123-
```
115+
## Thank you
124116

125-
3. Install from built zip: `./build/dbm-<OS>.*`
117+
---
126118

127-
4. Run dev mode
119+
- [Jetbrains](https://www.jetbrains.com/)
128120

129-
```bash
130-
yarn run dev
131-
```
121+
## Installation and Configuration
132122

133-
or
123+
---
134124

135-
```bash
136-
npm start
137-
```
125+
[Extended documentation for DBM](http://dbm-zh.edurt.io/reference/get_started/install.html)

angular.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,12 @@
3131
"inlineStyleLanguage": "scss",
3232
"assets": [
3333
"src/shared/assets",
34-
"src/renderer/assets"
34+
"src/renderer/assets",
35+
{
36+
"glob": "**/*",
37+
"input": "./node_modules/@ant-design/icons-angular/src/inline-svg/",
38+
"output": "/assets/"
39+
}
3540
],
3641
"styles": [
3742
"src/renderer/styles.scss",
Loading
Loading
Loading
Loading
37.7 KB
Loading
Loading
Loading
Loading
Loading
Loading
Loading

docs/docs/assets/integrate/Presto.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/docs/assets/integrate/Trino.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/docs/development/version/1.17.0-development.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ DBM Version for `1.17.0` is development!
2929

3030
---
3131

32-
#### Contributors (In no particular order)
3332

3433
---
3534

docs/docs/reference/get_started/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
template: overrides/main.html
33
---
44

5-
DBM is a cross-platform ClickHouse GUI desktop tool.
5+
DBM is a cross-platform Database GUI desktop tool.
66

77
#### System requirements
88

0 commit comments

Comments
 (0)