🧲 We are looking for an experienced frontend engineer to lead Bytebase frontend development. Check out our jobs page.

Bytebase is in public alpha and we may make breaking schema changes between versions. We plan to stabilize the schema around the middle of August. 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 support@bytebase.com and we will help you manually upgrade the schema.

Bytebase is a web-based, zero-config, dependency-free database schema change and version control management tool for developers and DBAs. It supports 2 mainstream schema change workflow:

• UI based SQL review
• Version control based schema migration (Database-as-Code)

Fig.1 - Dashboard

Fig.2 - SQL review issue pipeline

Fig.3 - GitLab based schema migration (Database-as-code)

Supported database engines

• MySQL

Planned

• PostgreSQL

Supported VCS

• GitLab EE/CE

Planned

• GitHub Enterprise
• GitLab.com
• GitHub.com

Visit docs.bytebase.com for more details

⚙️ Installation

Detailed installation guide

Run on localhost:8080

$ docker run --init --name bytebase --restart always --publish 8080:8080 --volume ~/.bytebase/data:/var/opt/bytebase bytebase/bytebase:0.4.1 --data /var/opt/bytebase --host http://localhost --port 8080

Run on https://bytebase.example.com

$ docker run --init --name bytebase --restart always --publish 80:80 --volume ~/.bytebase/data:/var/opt/bytebase bytebase/bytebase:0.4.1 --data /var/opt/bytebase --host https://bytebase.example.com --port 80

🕊 Interested in contributing?

1. Checkout issues tagged with good first issue.

2. We are maintaining an online database glossary list, you can add/improve content there.

🏗 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.
2. It requires zero config.
3. 1 command to start backend and 1 command to start frontend, both with live reload support.

Tech Stack

Data Model

Prerequisites

• Go (1.16 or later)
• Yarn
• Air (For backend live reload)

Steps

1. Install Air

2. Start backend using air (with live reload)

   $ air -c scripts/.air.toml

3. Start frontend (with live reload)

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