Skip to content

Commit b197560

Browse files
committed
chore: update readme.md
1 parent ed63464 commit b197560

File tree

4 files changed

+39
-7
lines changed

4 files changed

+39
-7
lines changed

README.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,33 @@
1-
# Tauri + Leptos
1+
# Tauri-Leptos PostgreSQL GUI
22

3-
This template should help get you started developing with Tauri and Leptos.
3+
## Introduction
44

5-
## Recommended IDE Setup
5+
Welcome to the Tauri-Leptos PostgreSQL GUI, a fully Rust-based application for efficient and secure database management. This application leverages the power of Rust for both frontend and backend development, providing a lightweight and cross-platform solution for PostgreSQL database management.
6+
7+
## Key Features
8+
9+
- **Pure Rust Development:** Entirely written in Rust, offering safety and performance.
10+
- **Lightweight and Secure:** Built with Tauri, ensuring a secure and resource-efficient desktop application.
11+
- **PostgreSQL Integration:** Tailored for effective management of PostgreSQL databases.
12+
13+
## Getting Started
14+
15+
### Prerequisites
16+
17+
- Rust Environment: Ensure Rust is installed on your system. Install from [rustup.rs](https://rustup.rs/).
18+
- Tauri Setup: Set up your development environment for Tauri following the [Tauri setup guide](https://tauri.studio/en/docs/getting-started/intro).
19+
20+
### Installation and Running
21+
22+
1. **Clone the Repository:** Download the project to your local machine.
23+
2. **Install Dependencies:** Navigate to the project directory and run `cargo install` to install the required Rust dependencies.
24+
3. **Build and Run:** Execute `cargo tauri build` to build the application. Once the build is complete, you can start the application.
25+
26+
## Feature Roadmap
27+
28+
### To-Do List
29+
30+
- [ ] **Connection Data Storage:** Implement secure storage for database connection details.
31+
- [ ] **Multi-Connection Support:** Enable the GUI to handle multiple database connections simultaneously.
32+
- [ ] **SQL Query Saving:** Allow users to save and manage their frequently used SQL queries.
633

7-
[VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer).

src-tauri/Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ edition = "2021"
1313
tauri-build = { version = "1.5", features = [] }
1414

1515
[dependencies]
16-
tauri = { version = "1.5.2", features = ["shell-open"] }
16+
tauri = { version = "1.5.3", features = ["shell-open"] }
1717
tauri-plugin-store = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v1" }
18-
serde = { version = "1.0.192", features = ["derive"] }
18+
serde = { version = "1.0.193", features = ["derive"] }
1919
serde_json = "1.0.108"
2020
tokio = "1.34.0"
2121
tokio-postgres = "0.7.10"

src-tauri/src/main.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ use postgres::{get_schema_tables, get_sql_result, pg_connector};
88
use std::sync::Arc;
99
#[cfg(debug_assertions)]
1010
use tauri::Manager;
11+
use tauri_plugin_store::StoreBuilder;
1112
use tokio::sync::Mutex;
1213
use tokio_postgres::Client;
1314

@@ -21,12 +22,17 @@ fn main() {
2122
tauri::Builder::default()
2223
.plugin(tauri_plugin_store::Builder::default().build())
2324
.setup(|app| {
25+
// create persistent storage
26+
StoreBuilder::new(app.app_handle(), "local_storage.bin".parse().unwrap()).build();
27+
28+
// open devtools if we are in debug mode
2429
#[cfg(debug_assertions)]
2530
{
2631
let window = app.get_window("main").unwrap();
2732
window.open_devtools();
2833
window.close_devtools();
2934
}
35+
3036
Ok(())
3137
})
3238
.manage(AppState::default())

src-tauri/tauri.conf.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
},
99
"package": {
1010
"productName": "Rust SQL GUI",
11-
"version": "1.0.0.alpha"
11+
"version": "1.0.0-alpha.1"
1212
},
1313
"tauri": {
1414
"allowlist": {

0 commit comments

Comments
 (0)