RelWave

Modern Database Management & Visualization

A powerful, cross-platform desktop tool built with Tauri, React, and TypeScript

📥 Download • ✨ Features • 🚀 Quick Start • 📚 Documentation

---

🎯 Why RelWave?

Unlike web-based database tools, RelWave runs natively on your desktop with direct connections to your databases, offering:

Native Performance Direct database connections without web overhead

Enhanced Security Encrypted credentials stored locally

Full Control Complete offline functionality

✨ Features

🗄️ Multi-Database Support

• PostgreSQL - Full support for advanced features
• MySQL - Complete MySQL 5.7+ compatibility
• MariaDB - Optimized for MariaDB-specific features

📊 Visual Database Tools

• ER Diagrams - Auto-generate entity-relationship diagrams
• Schema Explorer - Intuitive table and column browsing
• Data Visualization - Built-in charts and graphs
• Query Builder - Visual query construction

⚡ Developer-Friendly

• SQL Editor - Syntax highlighting and auto-completion
• Export Data - CSV, JSON, and SQL formats
• Connection Management - Save and organize multiple databases
• Auto-Updates - Stay up-to-date automatically

🚀 Quick Start

📥 Installation

Platform	Download	Description
Windows	.exe | .msi	NSIS installer (recommended) or MSI package
Linux	.deb | .AppImage	Debian package or portable AppImage

👉 Download the latest release →

🛠️ Build from Source

Click to expand build instructions

Prerequisites

# Required tools
- Node.js 18+
- pnpm
- Rust (for Tauri)

Steps

# 1. Clone the repository
git clone https://github.com/Relwave/relwave-app.git
cd relwave-app

# 2. Install dependencies
pnpm install

# 3. Install bridge dependencies
cd bridge && pnpm install && cd ..

# 4. Run in development mode
pnpm tauri dev

Building for Production

Windows:

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
pnpm tauri build

Linux:

# Install dependencies
sudo apt install libwebkit2gtk-4.1-dev libappindicator3-dev librsvg2-dev patchelf

# Build
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
pnpm tauri build

📚 Documentation

🏗️ Architecture

RelWave uses a bridge architecture for optimal performance:

The application uses a bridge architecture:

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

Benefits:

• 🚀 Native database drivers without Rust bindings
• 🔒 Process isolation for enhanced security
• 🎯 Optimized for each database type

📁 Project Structure

RelWave/
├── 🎨 src/                      # React frontend
│   ├── components/              # UI components
│   │   ├── chart/               # Visualization components
│   │   ├── er-diagram/          # ER diagram renderer
│   │   ├── query-builder/       # Visual query builder
│   │   └── schema-explorer/     # Schema navigation
│   ├── hooks/                   # Custom React hooks
│   ├── services/                # API layer
│   └── types/                   # TypeScript definitions
│
├── 🌉 bridge/                   # Database bridge (Node.js)
│   ├── src/
│   │   ├── connectors/          # Database drivers
│   │   ├── handlers/            # JSON-RPC handlers
│   │   ├── queries/             # SQL templates
│   │   └── services/            # Business logic
│   └── __tests__/               # Test suite
│
└── 🦀 src-tauri/                # Tauri backend (Rust)
    ├── src/                     # Rust source
    ├── capabilities/            # Permissions
    └── resources/               # Bundled assets

⚙️ Configuration

Database Connections:

Platform	Configuration Path
Windows	%APPDATA%\relwave\databases.json
Linux	~/.relwave/databases.json

🔐 Security Note: Credentials are encrypted and stored separately using machine-specific keys

Environment Variables:

Variable	Purpose
RELWAVE_HOME	Override default config directory

🧪 Testing

Running the Test Suite

Prerequisites

Start test databases with Docker:

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

Configure environment variables (create bridge/.env):

# PostgreSQL
REAL_POSTGRES_HOST=localhost
REAL_POSTGRES_PORT=5432
REAL_POSTGRES_USER=testuser
REAL_POSTGRES_PASSWORD=testpass
REAL_POSTGRES_DATABASE=testdb

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

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

Run Tests

cd bridge
pnpm test

Test Coverage

• ✅ Database service operations
• ✅ Connection management
• ✅ PostgreSQL integration
• ✅ MySQL integration
• ✅ MariaDB integration
• ✅ Query result caching
• ✅ Encryption & persistence

🤝 Contributing

We welcome contributions! Here's how to get started:

1. 🍴 Fork the repository
2. 🌿 Create a feature branch: git checkout -b feature/amazing-feature
3. 💾 Commit your changes: git commit -m 'Add amazing feature'
4. 📤 Push to the branch: git push origin feature/amazing-feature
5. 🎉 Open a Pull Request

📋 Contribution Guidelines

• Follow the existing code style
• Add tests for new features
• Update documentation as needed
• Ensure all tests pass before submitting

🔄 Auto-Updates

RelWave keeps itself up-to-date automatically:

• ✅ Checks for updates on startup
• ✅ Downloads in the background
• ✅ Prompts to install when ready
• ✅ Cryptographically signed releases

🛠️ Built With

Tauri Desktop Framework

React UI Library

TypeScript Type Safety

React Flow Diagrams

Tailwind CSS Styling

Special Thanks To

• Freepik - Logo design (via Flaticon)

📄 License

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

---

💙 Visualize Your Database with RelWave ✨

⭐ Star us on GitHub • 🐛 Report Bug • 💡 Request Feature

_{Made with ❤️ by the RelWave team}