Skip to content

Commit

Permalink
Merge pull request #167 from EdurtIO/develop
Browse files Browse the repository at this point in the history
Released for 1.17.0
  • Loading branch information
qianmoQ authored May 28, 2022
2 parents 2355406 + bade65d commit 74db9a1
Show file tree
Hide file tree
Showing 331 changed files with 1,501 additions and 22,232 deletions.
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,4 +125,4 @@ enforcement ladder](https://github.com/mozilla/diversity).

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
https://www.contributor-covenant.org/translations.
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## Contributing

[fork]: /fork
[pr]: /compare
[code-of-conduct]: CODE_OF_CONDUCT.md

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

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.

## Issues and PRs

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.

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.

## Submitting a pull request

1. [Fork][fork] and clone the repository.
1. Configure and install the dependencies: `npm install`.
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.
1. Create a new branch: `git checkout -b my-branch-name`.
1. Make your change, add tests, and make sure the tests still pass.
1. Push to your fork and [submit a pull request][pr].
1. Pat your self on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

- Write and update tests.
- 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.
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).

Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocked you.

## Resources

- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
- [GitHub Help](https://help.github.com)
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [2021] [incubator-dbm of copyright EdurtIO]
Copyright [2021] [dbm of copyright EdurtIO]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
108 changes: 48 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@
<a href="https://github.com/EdurtIO/incubator-dbm">
<img src="src/shared/assets/icons/favicon.png" alt="Logo" width="120px" height="120px">
</a>
<h2 align="center">DBM</h3>
<p align="center">
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>.
<br />
</p>
</p>

---

Contributors:
[![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)

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

Basic:
**Documentation**

[中文](http://dbm-zh.edurt.io/) <br />
[English](https://dbm.edurt.io/)

## Overview

---

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

Workflow:
## Workflow

[![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)
---

[![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)
**GitHub Actions workflow**

[![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)
[![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)
[![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)

Development:
**Development workflow**

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

GitHub:
## Mirror

---

**GitHub**

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

## Join Us
**Gitee**

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

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

## Thank you
---

- [Jetbrains](https://www.jetbrains.com/)
DBM can query data from any SQL-speaking datastore or data engine (ClickHouse and more).

Here are some of the major database solutions that are supported:

<p align="center">
<img src="./src/shared/assets/integrate/clickhouse.png" alt="clickhouse" border="0" width="133" height="34" />
<img src="./src/shared/assets/integrate/trino.png" alt="trino" border="0" width="46" height="46"/>
<img src="./src/shared/assets/integrate/presto.png" alt="presto" border="0" width="152" height="46"/>
</p>

## Features

## :rocket: Features
---

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

## :laughing: Download

- [Windows](https://github.com/EdurtIO/incubator-dbm/releases/download/1.4.0/dbm-win.zip)
- [Mac](https://github.com/EdurtIO/incubator-dbm/releases/download/1.4.0/dbm-mac.tar.gz)

## :gear: Installation

macOS and Windows

- Download zip from [here](https://github.com/EdurtIO/incubator-dbm/releases).
- Unzip the archive, and install to macOS Applications.

Other platforms

- Unsupported temporarily. You can install the DBM by [building from source](#hammer_and_wrench-build-from-source).

Install other versions?

- Go ahead to [Github Release](https://github.com/EdurtIO/incubator-dbm/releases) for all releases.

## :hammer_and_wrench: Build from source

1. Install dependencies
## Join Us

```bash
npm install -g node-sass
---

yarn install
```
Open the DingTalk software and scan the following QR code to join

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

```bash
yarn run build
```
## Thank you

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

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

```bash
yarn run dev
```
## Installation and Configuration

or
---

```bash
npm start
```
[Extended documentation for DBM](http://dbm-zh.edurt.io/reference/get_started/install.html)
7 changes: 6 additions & 1 deletion angular.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,12 @@
"inlineStyleLanguage": "scss",
"assets": [
"src/shared/assets",
"src/renderer/assets"
"src/renderer/assets",
{
"glob": "**/*",
"input": "./node_modules/@ant-design/icons-angular/src/inline-svg/",
"output": "/assets/"
}
],
"styles": [
"src/renderer/styles.scss",
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/assets/images/versions/1.17.0/img.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/assets/images/versions/1.17.0/img_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/assets/images/versions/1.17.0/img_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/assets/images/versions/1.17.0/img_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/assets/images/versions/1.17.0/img_5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/assets/images/versions/1.17.0/img_6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
1 change: 1 addition & 0 deletions docs/docs/assets/integrate/Presto.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/docs/assets/integrate/Trino.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion docs/docs/development/version/1.17.0-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ DBM Version for `1.17.0` is development!

---

#### Contributors (In no particular order)

---

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/get_started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
template: overrides/main.html
---

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

#### System requirements

Expand Down
Loading

0 comments on commit 74db9a1

Please sign in to comment.