From 603eae341654058e9a1547e9d0d55b19fb8ea0a6 Mon Sep 17 00:00:00 2001 From: Visal In Date: Wed, 2 Apr 2025 16:47:07 +0700 Subject: [PATCH 1/2] update readme --- README.md | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index c14c6a2c..ec9cb5b6 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,13 @@ [![Deploy to Cloudflare](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/outerbase/studio) -**Outerbase Studio** is a lightweight, browser-based GUI for managing SQL databases, designed for simplicity and versatility. Initially built for LibSQL and SQLite, it now supports a broad range of databases, including: +**Outerbase Studio** is a lightweight, browser-based GUI designed to simplify SQL database management with flexibility and ease. It supports a variety of databases, including SQLite-compatible options (D1, rqlite, Turso, etc.), as well as MySQL, Dolt, and PostgreSQL. Outerbase Studio is available in multiple formats to suit different needs: -**Supported Databases:** - -- **SQLite-based Database** - - Turso/LibSQL - - SQLite (local files) - - Cloudflare D1 - - rqlite - - StarbaseDB - - Val.town -- MySQL (beta, limited features) -- PostgreSQL (beta, limited features) +- **Hosted Browser**: Access it directly from your web browser. +- **[Desktop App](#desktop-app)**: Available for Mac, Windows, and Linux. +- **Command Line**: Manage databases via CLI tools. +- **[Docker](#docker)**: Deploy using containerized environments. +- **Embed**: Integrate seamlessly into your own applications. --- @@ -29,6 +23,18 @@ You can download [Windows and Mac desktop app here](https://github.com/outerbase Outerbase Studio Desktop is a lightweight Electron wrapper for the Outerbase Studio web version. It enables support for drivers that aren't feasible in a browser environment, such as MySQL and PostgreSQL. +## Docker + +We currently do not provide an official Docker image. However, this repository includes a `Dockerfile` that you can use to build and self-host your own instance. + +Some users have successfully utilized Docker Compose with the following configuration: + +```yaml +db-admin: + image: node:22-alpine + command: npx -y @outerbase/studio /data/data.sqlite +``` + ## Features ![libsqlstudio-git-preview (7)](https://github.com/user-attachments/assets/1d7a3d90-61e3-4a77-83a5-4bb096bbfb4b) From 2a72b7f40a6871e07f5d567c2700711c9b200e70 Mon Sep 17 00:00:00 2001 From: "Visal .In" Date: Wed, 2 Apr 2025 19:30:13 +0700 Subject: [PATCH 2/2] add command line instruction --- README.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index ec9cb5b6..88061a59 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,39 @@ # Outerbase Studio -[![Deploy to Cloudflare](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/outerbase/studio) - -**Outerbase Studio** is a lightweight, browser-based GUI designed to simplify SQL database management with flexibility and ease. It supports a variety of databases, including SQLite-compatible options (D1, rqlite, Turso, etc.), as well as MySQL, Dolt, and PostgreSQL. Outerbase Studio is available in multiple formats to suit different needs: +**Outerbase Studio** (aka LibSQL Studio) is a lightweight, browser-based GUI designed to simplify SQL database management with flexibility and ease. It supports a variety of databases, including SQLite-compatible options (D1, rqlite, Turso, Durable Object, etc.), as well as MySQL, Dolt, PostgreSQL, Worker Analytics Engine. Outerbase Studio is available in multiple formats to suit different needs: -- **Hosted Browser**: Access it directly from your web browser. +- **[Hosted Web App](#hosted-web-app)**: Access it directly from your web browser. - **[Desktop App](#desktop-app)**: Available for Mac, Windows, and Linux. -- **Command Line**: Manage databases via CLI tools. +- **[Command Line](#command-line)**: Manage databases via CLI tools. - **[Docker](#docker)**: Deploy using containerized environments. - **Embed**: Integrate seamlessly into your own applications. ---- +## Hosted Web App Give it a try directly from your browser [![LibSQL Studio, sqlite online editor](https://github.com/user-attachments/assets/5d92ce58-9ce6-4cd7-9c65-4763d2d3b231)](https://libsqlstudio.com) [![Libsql studio playground](https://github.com/user-attachments/assets/dcf7e246-fe72-4351-ab10-ae2d1658087d)](https://libsqlstudio.com/playground/client?template=chinook) +Hosted it on your own on Cloudflare + +[![Deploy to Cloudflare](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/outerbase/studio) + ## Desktop App You can download [Windows and Mac desktop app here](https://github.com/outerbase/studio-desktop/releases/). Outerbase Studio Desktop is a lightweight Electron wrapper for the Outerbase Studio web version. It enables support for drivers that aren't feasible in a browser environment, such as MySQL and PostgreSQL. +## Command Line + +@outerbase/studio lets you connect to databases and launch a web interface with a simple command. It can be used for explore your database or expose your database externally. [Learn more here](https://github.com/outerbase/studio-cli) + +```bash +npx @outerbase/studio sqlite.db +npx @outerbase/studio mysql://root:123456@localhost:3306/my_db +``` + ## Docker We currently do not provide an official Docker image. However, this repository includes a `Dockerfile` that you can use to build and self-host your own instance. @@ -34,14 +45,3 @@ db-admin: image: node:22-alpine command: npx -y @outerbase/studio /data/data.sqlite ``` - -## Features - -![libsqlstudio-git-preview (7)](https://github.com/user-attachments/assets/1d7a3d90-61e3-4a77-83a5-4bb096bbfb4b) - -- **Query Editor**: It features a user-friendly query editor equipped with auto-completion and function hint tooltips. It allows you to execute multiple queries simultaneously and view their results efficiently. -- **Data Editor**: It comes with a powerful data editor, allowing you to stage all your changes and preview them before committing. The data table is highly optimized and lightweight, capable of rendering thousands of rows and columns efficiently. -- **Schema Editor**: It allows you to quickly create, modify, and remove table columns with just a few clicks without writing any SQL. -- **Connection Manager**: It includes a flexible connection manager, allowing you to store your connections locally in your browser. You can also store them on a server and share your connections across multiple devices. - -The features mentioned above are just a few of the many we offer. Give it a try to explore everything we have in store