Skip to content

Commit

Permalink
chore: rename
Browse files Browse the repository at this point in the history
  • Loading branch information
frectonz committed Jun 21, 2024
1 parent 6b15615 commit 90d2ca6
Show file tree
Hide file tree
Showing 7 changed files with 27 additions and 57 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[package]
name = "sqlite-studio"
name = "sql-studio"
version = "0.1.8"
edition = "2021"
repository = "https://github.com/frectonz/sqlite-studio"
description = "Single binary, single command SQLite database explorer."
homepage = "https://sqlite-studio.frectonz.io/"
repository = "https://github.com/frectonz/sql-studio"
description = "Single binary, single command SQL Database Explorer."
homepage = "https://sql-studio.frectonz.io/"
authors = ["frectonz"]

[dependencies]
Expand Down
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# SQLite Studio
# SQL Studio

Single binary, single command SQLite database explorer. SQLite studio supports opening both *local SQLite DB files*, *libSQL servers* and *PostgreSQL*.
Single binary, single command SQL database explorer. SQL studio supports opening *local SQLite DB files*, *libSQL servers* and *PostgreSQL*.

### Local SQLite DB File

```bash
sqlite-studio sqlite [sqlite_db]
sql-studio sqlite [sqlite_db]
```

### Remote libSQL Server

```bash
sqlite-studio libsql [url] [auth_token]
sql-studio libsql [url] [auth_token]
```

### PostgreSQL Server

```bash
sqlite-studio postgres [url]
sql-studio postgres [url]
```

## Features
Expand All @@ -27,7 +27,7 @@ sqlite-studio postgres [url]
- Infinite scroll rows view.
- A custom query page that gives you more access to your db.

More features available on the [releases page](https://github.com/frectonz/sqlite-studio/releases).
More features available on the [releases page](https://github.com/frectonz/sql-studio/releases).

## Screenshots

Expand All @@ -38,50 +38,50 @@ More features available on the [releases page](https://github.com/frectonz/sqlit
### Tables Page

![tables](./screenshots/tables.png)
![infinite scroll](https://github.com/frectonz/sqlite-studio/assets/53809656/b6d8f627-4a21-46c2-bef7-8dea206b3689)
![infinite scroll](https://github.com/frectonz/sql-studio/assets/53809656/b6d8f627-4a21-46c2-bef7-8dea206b3689)

### Query Page

![query](./screenshots/query.png)
![query gif](https://github.com/frectonz/sqlite-studio/assets/53809656/3e47a890-ddd9-4c7f-be88-53e30cc23b15)
![query gif](https://github.com/frectonz/sql-studio/assets/53809656/3e47a890-ddd9-4c7f-be88-53e30cc23b15)

## Installation

### Install prebuilt binaries via shell script (MacOS and Linux)

```sh
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/frectonz/sqlite-studio/releases/download/0.1.8/sqlite-studio-installer.sh | sh
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/frectonz/sql-studio/releases/download/0.1.8/sql-studio-installer.sh | sh
```

### Install prebuilt binaries via powershell script

```sh
powershell -c "irm https://github.com/frectonz/sqlite-studio/releases/download/0.1.8/sqlite-studio-installer.ps1 | iex"
powershell -c "irm https://github.com/frectonz/sql-studio/releases/download/0.1.8/sql-studio-installer.ps1 | iex"
```

### Updating

```bash
sqlite-studio-update
sql-studio-update
```

## Nix

```bash
nix shell github:frectonz/sqlite-studio
nix shell github:frectonz/sql-studio
```

## Contributing

Before executing `cargo run` you need to build the UI because the rust app statically embedded the UI files in the binary.

```bash
git clone [email protected]:frectonz/sqlite-studio.git
cd sqlite-studio
git clone [email protected]:frectonz/sql-studio.git
cd sql-studio
nix develop # if you use nix
cd ui
npm install
npm run build
cd ..
cargo run <sqlite_db>
cargo run
```
4 changes: 2 additions & 2 deletions flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,10 @@
});

docker = pkgs.dockerTools.buildLayeredImage {
name = "sqlite-studio";
name = "sql-studio";
tag = "latest";
created = "now";
config.Cmd = [ "${bin}/bin/sqlite-studio" "--address=0.0.0.0:3030" "sqlite" "preview" ];
config.Cmd = [ "${bin}/bin/sql-studio" "--address=0.0.0.0:3030" "sqlite" "preview" ];
config.Expose = "3030";
};
in
Expand Down
30 changes: 0 additions & 30 deletions ui/README.md

This file was deleted.

2 changes: 1 addition & 1 deletion ui/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="icon" href="/icon.svg" type="image/svg+xml" />
<title>SQLite Studio</title>
<title>SQL Studio</title>

<link rel="preconnect" href="https://fonts.googleapis.com" />
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
Expand Down
8 changes: 4 additions & 4 deletions ui/src/routes/__root.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export function Root() {
className="flex items-center gap-2 text-lg font-semibold md:text-base"
>
<Database className="h-6 w-6 text-foreground" />
<span className="text-foreground">SQLite Studio</span>
<span className="text-foreground">SQL Studio</span>
</Link>
<Link
to="/"
Expand Down Expand Up @@ -74,7 +74,7 @@ export function Root() {
</button>
<a
target="_blank"
href="https://github.com/frectonz/sqlite-studio"
href="https://github.com/frectonz/sql-studio"
className="flex items-center justify-end gap-2 text-lg font-semibold md:text-base"
>
<Github className="h-6 w-6 " />
Expand Down Expand Up @@ -108,7 +108,7 @@ function MobileNav() {
className="flex items-center gap-2 text-lg font-semibold"
>
<Database className="size-6 text-foreground" />
<span className="text-foreground">SQLite Studio</span>
<span className="text-foreground">SQL Studio</span>
</Link>
<Link to="/" className="[&.active]:text-foreground text-foreground">
Overview
Expand All @@ -134,7 +134,7 @@ function MobileNav() {
className="flex sm:hidden items-center gap-2 text-lg font-semibold md:text-base"
>
<Database className="h-6 w-6 text-foreground" />
<span className="text-foreground">SQLite Studio</span>
<span className="text-foreground">SQL Studio</span>
</Link>
</div>
);
Expand Down

0 comments on commit 90d2ca6

Please sign in to comment.