Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tisonkun/bytebase
Web-based, zero-config, dependency-free database schema change and version control tool for teams. Public demo: https://demo.bytebase.com
https://github.com/tisonkun/bytebase
Last synced: 2 days ago
JSON representation
Web-based, zero-config, dependency-free database schema change and version control tool for teams. Public demo: https://demo.bytebase.com
- Host: GitHub
- URL: https://github.com/tisonkun/bytebase
- Owner: tisonkun
- License: other
- Fork: true (bytebase/bytebase)
- Created: 2022-02-19T10:48:21.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-07-23T06:21:55.000Z (about 2 years ago)
- Last Synced: 2023-03-04T00:27:49.273Z (over 1 year ago)
- Homepage: https://bytebase.com
- Size: 54.3 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
Live Demo •
Install •
Help •
Development •
Design Doc
[Bytebase](https://bytebase.com/) is a **web-based**, **zero-config**, **dependency-free** database schema change and version control management tool for developers and DBAs.
- [x] Web-based schema change and management workspace for teams
- [x] Version control based schema migration (Database-as-Code)
- [x] Classic UI based schema migraiton (SQL Review)
- [x] Built-in SQL Editor
- [x] Detailed migration history
- [x] Backup and restore
- [x] Anomaly center
- [x] Environment policy
- Approval policy
- Backup schedule enforcement
- [x] Schema drift detection
- [x] Backward compatibility schema change check
- [x] Role-based access control (RBAC)
- [x] MySQL support
- [x] PostgreSQL support
- [x] TiDB support
- [x] Snowflake support
- [x] ClickHouse support
- [x] GitLab CE/EE support
- [x] Webhook integration for Slack, Discord, MS Teams, DingTalk(钉钉), Feishu(飞书), WeCom(企业微信)
- [ ] GitLab.com support
- [ ] GitHub support
Fig.1 - Dashboard
Fig.2 - SQL review issue pipeline
Fig.3 - GitLab based schema migration (Database-as-code)
Fig.4 - Built-in SQL Editor
## Installation
[Detailed installation guide](https://docs.bytebase.com/install/docker)
### Run on localhost:8080
```bash
docker run --init --name bytebase --restart always --publish 8080:8080 --volume ~/.bytebase/data:/var/opt/bytebase bytebase/bytebase:0.13.0 --data /var/opt/bytebase --host http://localhost --port 8080
```
### Run on https://bytebase.example.com
```bash
docker run --init --name bytebase --restart always --publish 80:80 --volume ~/.bytebase/data:/var/opt/bytebase bytebase/bytebase:0.13.0 --data /var/opt/bytebase --host https://bytebase.example.com --port 80
```
## 📕 Docs
### User doc https://docs.bytebase.com
In particular, get familar with various product concept such as [data model](https://docs.bytebase.com/concepts/data-model), [roles and permissions](https://docs.bytebase.com/concepts/roles-and-permissions) and etc.
### Design doc
https://github.com/bytebase/bytebase/tree/main/docs/design
## 🕊 Interested in contributing?
1. Checkout issues tagged with [good first issue](https://github.com/bytebase/bytebase/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
1. We are maintaining an [online database glossary list](https://bytebase.com/database-glossary/), you can add/improve content there.
**Note**: We are quite disciplined on tech stack. If you consider bringing a new programming language, framework and any non-trivial external dependency, please open a discussion first.
## 🏗 Development
Bytebase is built with a curated tech stack. It is optimized for **developer experience** and is very easy to start
working on the code:
1. It has no external dependency.
1. It requires zero config.
1. 1 command to start backend and 1 command to start frontend, both with live reload support.
**Tech Stack**
**Data Model**
### Prerequisites
- [Go](https://golang.org/doc/install) (1.16 or later)
- [Yarn](https://yarnpkg.com/getting-started/install)
- [Air](https://github.com/cosmtrek/air#installation) (For backend live reload)
### Steps
1. Install [Air](https://github.com/cosmtrek/air#installation).
1. Pull source.
```bash
git clone https://github.com/bytebase/bytebase
```
1. Set up pre-commit hooks.
- Install [pre-commit](https://pre-commit.com/index.html#install)
```bash
cd bytebase
pre-commit install
pre-commit install --hook-type commit-msg
```
1. Start backend using air (with live reload).
```bash
air -c scripts/.air.toml
```
Change the open file limit if you encounter "error: too many open files".
```
ulimit -n 10240
```
1. Start frontend (with live reload).
```bash
cd frontend && yarn && yarn dev
```
Bytebase should now be running at https://localhost:3000 and change either frontend or backend code would trigger live reload.
### Coding guideline
[Here](https://github.com/bytebase/bytebase/tree/main/docs/coding-guide.md)
## Notice
> Bytebase is in public alpha and we may make breaking schema changes between versions. We plan to stabilize the schema by the end of Jan 2022. In the mean time, if you are eager to try Bytebase for your business and encounter
> issue when upgrading to the new version. Please contact [email protected] or join our Discord server, and we will help you manually upgrade the schema.
## Star History
[](https://star-history.com/#bytebase/bytebase&Date)
## We are hiring
We are looking for engineers and developer advocates, interns are also welcomed. Check out our [jobs page](https://bytebase.com/jobs).