|
1 | 1 |
|
2 | 2 | <div align="center"> |
3 | | - <img src="https://raw.githubusercontent.com/parevo/mergen/refs/heads/main/assets/mergen.png" alt="Mergen Logo" width="120" height="120" /> |
| 3 | + <img src="https://raw.githubusercontent.com/parevo/mergen/refs/heads/main/assets/mergen.png" alt="Mergen Logo" width="150" height="150" /> |
4 | 4 | <h1>Mergen</h1> |
| 5 | + <h3>The Art of Database Management</h3> |
5 | 6 | <p> |
6 | | - <b>The Aesthetic & High-Performance Database Client</b> |
| 7 | + <b>Beautiful. Powerful. Native.</b> |
7 | 8 | </p> |
8 | 9 | <p> |
9 | | - Built for the modern developer. Native speed, web flexibility. |
| 10 | + Redefining the standard for modern database clients. |
10 | 11 | </p> |
11 | 12 |
|
12 | | - [](https://goreportcard.com/report/github.com/ahmetbilgay/rune) |
13 | | - [](LICENSE) |
| 13 | + [](https://goreportcard.com/report/github.com/parevo/mergen) |
| 14 | + [](LICENSE) |
14 | 15 | [](https://wails.io) |
15 | 16 | [](https://reactjs.org) |
16 | 17 |
|
17 | 18 | <br /> |
18 | 19 |
|
19 | | - <img src="./assets/preview.png" alt="RuneDB Application Preview" width="100%" style="border-radius: 10px; box-shadow: 0 10px 30px rgba(0,0,0,0.5);" /> |
| 20 | + <img src="./assets/preview.png" alt="Mergen Application Preview" width="100%" style="border-radius: 12px; box-shadow: 0 20px 60px rgba(0,0,0,0.5); border: 1px solid rgba(255,255,255,0.1);" /> |
20 | 21 | </div> |
21 | 22 |
|
22 | 23 | <br /> |
23 | 24 |
|
24 | | -## ⚡ What is Mergen? |
| 25 | +## 🌟 Why Mergen? |
25 | 26 |
|
26 | | -**Mergen** is a next-generation database management tool designed to bridge the gap between **native performance** and **modern web aesthetics**. |
| 27 | +In a world of clunky, Electron-heavy database tools, **Mergen** stands apart. We built Mergen with a single philosophy: **Developer tools should be as beautiful as they are powerful.** |
27 | 28 |
|
28 | | -Unlike clunky, legacy SQL clients, Mergen offers a buttery-smooth experience with a focus on visual clarity. Written in **Go** and **React**, it starts instantly, runs everywhere, and looks beautiful doing it. |
| 29 | +Mergen combines the raw performance of **Go** with the fluid interactivity of **React**, delivering an experience that feels native, instant, and incredibly responsive. It's not just a tool; it's a workspace you'll love to inhabit. |
29 | 30 |
|
30 | 31 | --- |
31 | 32 |
|
32 | | -## ✨ Key Features |
| 33 | +## 🚀 Key Features |
| 34 | + |
| 35 | +### ✨ **Unmatched Aesthetics** |
| 36 | +Experience a UI designed for focus and clarity. |
| 37 | +- **Glassmorphism Design**: Modern, translucent interfaces that blend perfectly with your OS. |
| 38 | +- **Adaptive Themes**: Seamlessly switches between Dark and Light modes. Choose from curated palettes like *Ocean Blue*, *Royal Purple*, and *Forest Green*. |
| 39 | +- **Distraction-Free**: A clean workspace that puts your data front and center. |
| 40 | + |
| 41 | +### 🛡️ **Fortress-Level Reliability & Security** |
| 42 | +Your data is your most valuable asset. Mergen treats it that way. |
| 43 | +- **SSH Tunneling**: Securely access production databases without exposing ports to the public internet. Native, encrypted tunneling built-in. |
| 44 | +- **Local-First Architecture**: Your connection credentials and queries **never** leave your machine. No cloud sync, no tracking, complete privacy. |
| 45 | +- **SSL/TLS Support**: Full support for encrypted database connections. |
| 46 | +- **Safe Mode Editing**: Changes in the Data Editor are staged first. Commit only when you're ready, preventing accidental data loss. |
| 47 | + |
| 48 | +### ⚡ **Native Performance** |
| 49 | +Forget about loading spinners and laggy inputs. |
| 50 | +- **Go Backend**: Powered by a robust Go core for blazing-fast connection handling and query execution. |
| 51 | +- **Low Footprint**: Consumes a fraction of the RAM compared to traditional Electron apps. |
| 52 | +- **Instant Startup**: Launches in milliseconds, ready when you are. |
| 53 | + |
| 54 | +### 🧠 **Intelligent Workflow** |
| 55 | +Work smarter, not harder. |
| 56 | +- **Command Palette (`Cmd+K`)**: Navigate anywhere, execute commands, toggle connections, and switch contexts without ever lifting your hands from the keyboard. |
| 57 | +- **Multi-Tab Interface**: Juggle multiple queries, table views, and visualizations simultaneously. |
| 58 | +- **Smart Autocomplete**: Context-aware SQL suggestions help you write queries faster and with fewer errors. |
| 59 | + |
| 60 | +### 📊 **Data Visualization** |
| 61 | +Don't just read data—see it. |
| 62 | +- **Instant Charts**: Turn any query result into a visual masterpiece with one click. |
| 63 | +- **Rich Chart Types**: Bar, Line, Area, and Pie charts available instantly. |
| 64 | +- **Interactive**: Hover, zoom, and explore your data visually to find insights faster. |
| 65 | + |
| 66 | +### 🛠️ **Power User Tools** |
| 67 | +- **Data Editor**: A spreadsheet-like interface for quick edits. Double-click to modify, add rows, or delete data. |
| 68 | +- **Universal Export**: Export your data to Excel (`.xlsx`), CSV, or JSON formats effortlessly. |
| 69 | +- **Query History**: Never lose a complex query again. Access your execution history instantly. |
33 | 70 |
|
34 | | -### 🚀 **Native Performance** |
35 | | -Powered by a **Go** backend and the **Wails** framework, Mergen consumes a fraction of the memory of Electron-based apps while delivering native-speed query execution. |
36 | | - |
37 | | -### 🎨 **Stunning Visuals & Theming** |
38 | | -- **Adaptive UI**: Seamlessly switches between Dark and Light modes. |
39 | | -- **Modern Design**: Clean typography, glassmorphism accents, and a clutter-free workspace. |
| 71 | +--- |
40 | 72 |
|
41 | | -### 🛡️ **Secure Access** |
42 | | -- **SSH Tunneling**: Connect to your production databases securely through SSH tunnels. Native support built right in. |
43 | | -- **Connection Manager**: Organize your connections (MySQL, PostgreSQL) with ease. |
| 73 | +## 🥊 Mergen vs. The Rest |
44 | 74 |
|
45 | | -### ⌨️ **Developer-First Workflow** |
46 | | -- **Command Palette (`Cmd+K`)**: Navigate anywhere, execute commands, and switch contexts without lifting your hands from the keyboard. |
47 | | -- **Multi-Tab Interface**: juggle multiple queries and table views simultaneously without losing context. |
| 75 | +Why settle for bloated, expensive tools when you can have perfection? |
48 | 76 |
|
49 | | -### 📊 **Visual Data Editor** |
50 | | -- **Spreadsheet-like Editing**: Double-click to edit cells, add rows, or delete data. |
51 | | -- **Safe Mode**: Changes are staged before committing, preventing accidental data loss. |
| 77 | +| Feature | **Mergen** | Electron Apps (TablePlus, DBeaver) | Legacy Tools (Workbench) | |
| 78 | +| :--- | :--- | :--- | :--- | |
| 79 | +| **RAM Usage** | **~25 MB** (Native) | ~400 MB+ (Chromium) | Varies, often heavy | |
| 80 | +| **Startup Time** | **Instant** (< 0.5s) | Sluggish (3s+) | Measured in ages | |
| 81 | +| **App Size** | **Tiny** (~15 MB) | Huge (150 MB+) | Bloated | |
| 82 | +| **Cost** | **Free & Open Source** | Expensive Subscriptions | Free / Expensive | |
| 83 | +| **Privacy** | **100% Local** | Cloud Sync / Telemetry | Varies | |
| 84 | +| **UI/UX** | **State of the Art** | Utilitarian / Clunky | Dated, Complex | |
52 | 85 |
|
53 | | -### 📥 **Universal Data Export** |
54 | | -- **Flexibility**: Export entire datasets to Excel (`.xlsx`), CSV, or JSON formats in one click. |
55 | | -- **Native Experience**: Uses native system dialogs for saving files, integrating seamlessly with your OS. |
| 86 | +**The Truth About Electron:** |
| 87 | +Most modern database tools are built on Electron, effectively bundling a whole web browser with every app. This eats your RAM, drains your battery, and slows down your workflow. |
56 | 88 |
|
57 | | -### 🔄 **Stay Updated** |
58 | | -- **Auto-Update**: Mergen automatically checks for updates, ensuring you always have the latest features and security patches. |
| 89 | +**Mergen is different.** By using Wails, we leverage the native webview already present on your OS. The result? An app that looks better, runs faster, and respects your hardware. Don't pay for bloat. Choose Mergen. |
59 | 90 |
|
60 | 91 | --- |
61 | 92 |
|
62 | | -## 🛠️ Tech Stack |
| 93 | +## 🛠️ Technology Stack |
63 | 94 |
|
64 | | -Mergen is built on the shoulders of giants: |
| 95 | +Built on the shoulders of giants for maximum stability and performance: |
65 | 96 |
|
66 | | -| Component | Technology | Description | |
67 | | -|-----------|------------|-------------| |
68 | | -| **Core** | [Wails v2](https://wails.io) | The bridge between Go and the web frontend. | |
69 | | -| **Backend** | [Go (Golang)](https://go.dev) | Handles DB connections, SSH tunneling, and file I/O. | |
70 | | -| **Frontend** | [React](https://reactjs.org) | Component-based UI architecure. | |
71 | | -| **Styling** | [Tailwind CSS](https://tailwindcss.com) | Utility-first styling for rapid UI development. | |
72 | | -| **State** | TypeScript | Type-safe interactions across the entire stack. | |
| 97 | +| Component | Technology | Why we chose it | |
| 98 | +|-----------|------------|-----------------| |
| 99 | +| **Core** | [Wails v2](https://wails.io) | The bridge between Go and the web, enabling native performance with web UI flexibility. | |
| 100 | +| **Backend** | [Go (Golang)](https://go.dev) | Unmatched concurrency and speed for handling database connections and I/O. | |
| 101 | +| **Frontend** | [React](https://reactjs.org) | The industry standard for building dynamic, responsive user interfaces. | |
| 102 | +| **Styling** | [Tailwind CSS](https://tailwindcss.com) | For pixel-perfect, modern, and maintainable styling. | |
| 103 | +| **Database** | MySQL / PostgreSQL | First-class support for the world's most popular databases. | |
73 | 104 |
|
74 | 105 | --- |
75 | 106 |
|
76 | | -## 🚀 Getting Started |
| 107 | +## 📥 Installation |
77 | 108 |
|
78 | 109 | ### Prerequisites |
79 | | - |
80 | 110 | - **Go**: v1.23 or higher |
81 | 111 | - **Node.js**: v20 or higher |
82 | | -- **NPM**: Latest version |
83 | 112 |
|
84 | | -### Installation (Development) |
| 113 | +### Building from Source |
85 | 114 |
|
86 | 115 | 1. **Clone the repository** |
87 | 116 | ```bash |
88 | | - git clone https://github.com/ahmetbilgay/rune.git |
89 | | - cd rune |
| 117 | + git clone https://github.com/parevo/mergen.git |
| 118 | + cd mergen |
90 | 119 | ``` |
91 | 120 |
|
92 | | -2. **Install dependencies** |
| 121 | +2. **Install Frontend Dependencies** |
93 | 122 | ```bash |
94 | | - # Frontend dependencies |
95 | | - cd frontend && npm install && cd .. |
| 123 | + cd frontend |
| 124 | + npm install |
| 125 | + cd .. |
96 | 126 | ``` |
97 | 127 |
|
98 | | -3. **Run in Dev Mode** |
| 128 | +3. **Run in Development Mode** |
99 | 129 | ```bash |
100 | 130 | wails dev |
101 | | - # This will launch the app and hot-reload on changes |
102 | 131 | ``` |
103 | 132 |
|
104 | | -### Building for Production |
105 | | - |
106 | | -To create a standalone binary for your OS: |
| 133 | +4. **Build for Production** |
| 134 | + ```bash |
| 135 | + wails build |
| 136 | + ``` |
| 137 | + The optimized binary will be available in `build/bin/`. |
107 | 138 |
|
108 | | -```bash |
109 | | -wails build |
110 | | -``` |
| 139 | +--- |
111 | 140 |
|
112 | | -The output binary will be located in the `build/bin/` directory. |
| 141 | +## 🔄 Auto-Updates |
| 142 | +Mergen respects your time. The built-in updater automatically checks for new releases on GitHub, downloading and applying patches seamlessly so you're always on the cutting edge. |
113 | 143 |
|
114 | 144 | --- |
115 | 145 |
|
116 | 146 | ## 🤝 Contributing |
117 | | - |
118 | | -We love contributions! Whether it's a bug fix, a new feature, or just a typo fix: |
119 | | - |
120 | | -1. Fork the project. |
| 147 | +We believe in the power of open source. Found a bug? Have a feature request? |
| 148 | +1. Fork the repo. |
121 | 149 | 2. Create your feature branch (`git checkout -b feature/AmazingFeature`). |
122 | | -3. Commit your changes (`git commit -m 'Add some AmazingFeature'`). |
123 | | -4. Push to the branch (`git push origin feature/AmazingFeature`). |
124 | | -5. Open a Pull Request. |
| 150 | +3. Commit your changes. |
| 151 | +4. Open a Pull Request. |
125 | 152 |
|
126 | 153 | --- |
127 | 154 |
|
128 | 155 | ## 📄 License |
129 | | - |
130 | 156 | Distributed under the MIT License. See `LICENSE` for more information. |
131 | 157 |
|
132 | 158 | --- |
133 | 159 |
|
134 | 160 | <div align="center"> |
135 | | - <p>Built with ❤️ by <a href="https://github.com/ahmetbilgay">Ahmet Can Bilgay</a></p> |
| 161 | + <p>Built with ❤️ and ☕ by <a href="https://github.com/ahmetbilgay">Ahmet Can Bilgay</a></p> |
| 162 | + <p><i>make something wonderful.</i></p> |
136 | 163 | </div> |
0 commit comments