RelWave

A modern, cross-platform database management and visualization tool
Built with Tauri, React, and TypeScript

Download | Features | Installation | Contributing

Overview

RelWave is a powerful desktop application that provides an intuitive interface for managing and visualizing your databases. It supports PostgreSQL and MySQL databases with features like schema exploration, ER diagram generation, query building, and data visualization.

Why RelWave? Unlike web-based tools, RelWave runs natively on your machine with direct database connections, providing better performance and security.

Features

Database Management

Multi-database support - Connect to multiple PostgreSQL and MySQL databases
Secure storage - Credential encryption with machine-specific keys
Health monitoring - Connection status and health checks
Statistics dashboard - Database metrics at a glance

Schema Explorer

Visual browsing - Navigate schemas, tables, and columns
Constraint details - View types, indexes, and constraints
Relationship mapping - Inspect foreign key relationships
Metadata panel - Detailed information for any object

ER Diagram

Auto-generation - Instant entity relationship diagrams
Interactive canvas - Zoom, pan, and rearrange nodes
Relationship lines - Visual foreign key connections
Export support - Save diagrams as PNG images

Query Builder

Visual interface - Build queries without writing SQL
Drag and drop - Add tables by dragging nodes
SQL generation - Auto-generate SQL from selections
Instant execution - Run and view results immediately

SQL Workspace

Multi-tab editor - Work on multiple queries simultaneously
Syntax highlighting - SQL-aware code editor
Execution metrics - Query timing and row counts
Query history - Track and rerun previous queries

Data Visualization

Chart generation - Visualize query results instantly
Multiple types - Bar, line, pie, and area charts
Customization - Configure axes, colors, and labels
Export options - Save charts as images

Additional Features

Dark/Light themes - Choose your preferred appearance
Auto-updates - Automatic update notifications
Cross-platform - Windows and Linux support
Developer mode - Access DevTools for debugging

Tech Stack

Layer	Technologies
Frontend	React 19, TypeScript, Vite, TailwindCSS
UI Components	Radix UI, Lucide Icons
Diagrams	React Flow, Dagre (auto-layout)
Charts	Recharts
SQL Editor	CodeMirror
State Management	TanStack Query
Desktop Runtime	Tauri 2 (Rust)
Database Bridge	Node.js with pg, mysql2 drivers

Prerequisites

Before building from source, ensure you have:

Requirement	Version
Node.js	20 or later
pnpm	8 or later
Rust	1.70 or later
Build Tools	Visual Studio Build Tools (Windows) or build-essential (Linux)

Installation

From Releases (Recommended)

Download the latest release for your platform from the Releases page:

Platform	File Type	Description
Windows	`.exe`	NSIS installer (recommended)
Windows	`.msi`	MSI installer
Linux	`.deb`	Debian/Ubuntu package
Linux	`.AppImage`	Portable application

From Source

Clone the repository:

git clone https://github.com/Relwave/relwave-app.git
cd RelWave

Install frontend dependencies:

pnpm install

Install bridge dependencies:

cd bridge
pnpm install
cd ..

Run in development mode:

pnpm tauri dev

Building

Windows

# Build the bridge
cd bridge
pnpm build
cd ..
npx pkg ./bridge/dist/index.cjs --target node18-win-x64 --output ./src-tauri/resources/bridge-x86_64-pc-windows-msvc.exe

# Build the application
pnpm tauri build

Output files will be in src-tauri/target/release/bundle/.

Linux

# Install dependencies (Ubuntu/Debian)
sudo apt install libwebkit2gtk-4.1-dev libappindicator3-dev librsvg2-dev patchelf

# Build the bridge
cd bridge
pnpm build
cd ..
npx pkg ./bridge/dist/index.cjs --target node18-linux-x64 --output ./src-tauri/resources/bridge-x86_64-unknown-linux-gnu

# Build the application
pnpm tauri build

Output files will be in src-tauri/target/release/bundle/.

Project Structure

RelWave/
├── src/                    # Frontend React application
│   ├── components/         # React components
│   │   ├── chart/          # Chart visualization components
│   │   ├── common/         # Shared components
│   │   ├── database/       # Database-related components
│   │   ├── er-diagram/     # ER diagram components
│   │   ├── home/           # Home page components
│   │   ├── query-builder/  # Query builder components
│   │   ├── schema-explorer/# Schema explorer components
│   │   └── ui/             # Base UI components
│   ├── hooks/              # Custom React hooks
│   ├── pages/              # Page components
│   ├── services/           # API services
│   ├── types/              # TypeScript types
│   └── lib/                # Utility functions
├── bridge/                 # Node.js database bridge
│   ├── src/
│   │   ├── connectors/     # Database connectors (MySQL, PostgreSQL)
│   │   ├── handlers/       # JSON-RPC handlers
│   │   ├── queries/        # SQL query templates
│   │   ├── services/       # Business logic services
│   │   ├── types/          # TypeScript types
│   │   └── utils/          # Utility functions
│   └── __tests__/          # Jest tests
├── src-tauri/              # Tauri Rust backend
│   ├── src/                # Rust source files
│   ├── capabilities/       # Tauri permissions
│   ├── icons/              # Application icons
│   └── resources/          # Bundled resources
└── .github/
    └── workflows/          # GitHub Actions workflows

Configuration

Database Connections

Database connection configurations are stored in:

Platform	Location
Windows	`%APPDATA%\relwave\databases.json`
Linux	`~/.relwave/databases.json`

Note: Credentials are encrypted and stored separately in a .credentials file using machine-specific keys.

Environment Variables

Variable	Description
`RELWAVE_HOME`	Override the default configuration directory

Development

Running Tests

The bridge includes a comprehensive test suite with integration tests for database connectors.

Prerequisites

Docker - Required for running test databases:

cd bridge
docker-compose -f docker-compose.test.yml up -d

This starts PostgreSQL, MySQL, and MariaDB containers for testing.

Environment Variables - Create a .env file in the bridge directory:

# PostgreSQL Test Configuration
REAL_POSTGRES_HOST=localhost
REAL_POSTGRES_PORT=5432
REAL_POSTGRES_USER=testuser
REAL_POSTGRES_PASSWORD=testpass
REAL_POSTGRES_DATABASE=testdb
REAL_POSTGRES_SSL=false

# MySQL Test Configuration
REAL_MYSQL_HOST=localhost
REAL_MYSQL_PORT=3306
REAL_MYSQL_USER=testuser
REAL_MYSQL_PASSWORD=testpass
REAL_MYSQL_DATABASE=testdb

# MariaDB Test Configuration
REAL_MARIADB_HOST=localhost
REAL_MARIADB_PORT=3307
REAL_MARIADB_USER=testuser
REAL_MARIADB_PASSWORD=testpass
REAL_MARIADB_DATABASE=testdb

Running Tests

cd bridge
pnpm test

Test Suites

Test Suite	Description
`databaseService.test.ts`	Database service CRUD operations and validation
`dbStore.test.ts`	Database store caching, encryption, and persistence
`connectionBuilder.test.ts`	Connection configuration building
`postgres.test.ts`	PostgreSQL connector integration tests
`mysql.test.ts`	MySQL connector integration tests
`mariadb.test.ts`	MariaDB connector integration tests
`*.cache.test.ts`	Query result caching tests for each connector

Stopping Test Databases

cd bridge
docker-compose -f docker-compose.test.yml down

Architecture

The application uses a bridge architecture:

┌─────────────────┐     JSON-RPC     ┌─────────────────┐
│   Tauri/React   │ <──────────────> │  Node.js Bridge │
│    Frontend     │   stdin/stdout   │   (pg, mysql2)  │
└─────────────────┘                  └─────────────────┘
                                              │
                                              ▼
                                     ┌─────────────────┐
                                     │    Databases    │
                                     │ PostgreSQL/MySQL│
                                     └─────────────────┘

This architecture allows native database drivers without Rust bindings.

Adding a New Database Type

Create a new connector in bridge/src/connectors/
Add query templates in bridge/src/queries/
Register the connector in bridge/src/services/databaseService.ts
Update types in bridge/src/types/

Auto-Updates

RelWave includes automatic update functionality:

Checks for updates on application start
Downloads updates in the background
Prompts to restart when ready
Updates distributed via GitHub Releases

Updates are cryptographically signed to ensure authenticity.

Contributing

Contributions are welcome! Here's how to get started:

Fork the repository
Create a feature branch: git checkout -b feature/my-feature
Commit your changes: git commit -am 'Add my feature'
Push to the branch: git push origin feature/my-feature
Submit a pull request

Please ensure your code follows the existing style and includes appropriate tests.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

Built with these amazing open-source projects:

Project	Description
Tauri	Desktop application framework
React	UI library
React Flow	Node-based diagram library
Recharts	Charting library
Radix UI	Accessible UI components
TailwindCSS	Utility-first CSS framework

Attribution

Logo icon designed by Freepik from Flaticon

Made with care by Yash Saini

Name		Name	Last commit message	Last commit date
Latest commit History 144 Commits
.github/workflows		.github/workflows
.vscode		.vscode
bridge		bridge
public		public
src-tauri		src-tauri
src		src
.gitignore		.gitignore
FEATURES.md		FEATURES.md
LICENSE		LICENSE
README.md		README.md
components.json		components.json
image.png		image.png
index.html		index.html
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
tsconfig.json		tsconfig.json
tsconfig.node.json		tsconfig.node.json
vite.config.ts		vite.config.ts

License

Relwave/relwave-app

Folders and files

Latest commit

History

Repository files navigation

RelWave

Overview

Features

Database Management

Schema Explorer

ER Diagram

Query Builder

SQL Workspace

Data Visualization

Additional Features

Tech Stack

Prerequisites

Installation

From Releases (Recommended)

From Source

Building

Windows

Linux

Project Structure

Configuration

Database Connections

Environment Variables

Development

Running Tests

Prerequisites

Running Tests

Test Suites

Stopping Test Databases

Architecture

Adding a New Database Type

Auto-Updates

Contributing

License

Acknowledgments

Attribution

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases 5

Packages 0

Languages

Packages