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

• UI based SQL review
• Version control 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.1.0 --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.1.0 --data /var/opt/bytebase --host https://bytebase.example.com --port 80

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

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.