code-review

OrcaQ is a modern desktop application designed for managing, querying, and manipulating data across various database management systems (DBMS) in an intuitive, fast, and secure manner. Built with [Electron](https://www.electronjs.org/), [Vue 3](https://vuejs.org/), [TypeScript](https://www.typescriptlang.org/), and [Vite](https://vitejs.dev/), it targets developers, data engineers, analysts, DBAs, or anyone who needs to work with SQL/PostgreSQL data on the desktop.

• 🚀 Cross-platform Desktop App: Runs smoothly on Windows, macOS, and Linux thanks to Electron.
• 🖥️ Modern UI/UX: Minimalist interface with dark mode support, drag & drop, and flexible sidebar.
• ⚡ Quick Query: Fast data querying with preview, filtering, and dynamic field search.
• 📝 Raw SQL Editor: Write and execute SQL queries with multiple layout modes (vertical/horizontal).
• 🗂️ Explorer: Browse database structures, tables, schemas, and files.
• 🔒 Workspace & Connection Management: Manage multiple connections and independent workspaces.
• 🛠️ Hotkey Support: Supports shortcuts for faster operations.
• ⚙️ Electron Backend: Leverages Node.js, native modules, and OS integration.

Requirements

• Node.js >= 18.x
• pnpm or bun
• macOS, Windows, or Linux

Steps (Web setup)

1. Clone the repository:

```sh

git clone https://github.com/cin12211/orca-q.git

cd orcaq

```

1. Install dependencies:

```sh

bun install

```

1. Run in development mode:

```sh

npm run nuxt:dev

```

1. Build for production:

```sh

npm run nuxt:build

```

Steps (App setup)

1. Clone the repository:

```sh

git clone https://github.com/cin12211/orca-q.git

cd orcaq

```

1. Install dependencies:

```sh

bun install

```

1. Run in development mode:

```sh

npm run dev

```

1. Build for production:

```sh

npm run app:build

```

> Note: Ensure you have the correct Node.js version and necessary dependencies installed to run Electron. See more at [Electron Docs](https://www.electronjs.org/docs/latest/tutorial/quick-start).

• Launch the app:

Run npm run dev to start the application in development mode.

• Connect to a database:

Add a workspace, create a new connection, and enter DB details (PostgreSQL, etc.).

• Quick Query:

Use the Quick Query tab to filter, search, and view table data.

• SQL Editing:

Switch to the Raw Query tab to write and execute custom SQL queries.

• Manage Layout:

Use the sidebar and hotkeys (Cmd+Shift+B on Mac) to show/hide panels.

We welcome all contributions!

1. Fork the repo and create a new branch:

```sh

git checkout -b feat/my-feature

```

1. Follow commit conventions:

- feat: ... Add a new feature

- fix: ... Fix a bug

- chore: ... Miscellaneous tasks

- docs: ... Update documentation

- refactor: ... Improve code without changing logic

1. Create a Pull Request:

Clearly describe changes and link to relevant issues (if any).

1. Review & Merge:

The core team will review and provide feedback promptly.

See more: [CONTRIBUTING.md](CONTRIBUTING.md)

• [x] Quick Query UI/UX
• [x] Raw SQL Editor
• [x] Sidebar/Panel Layout
• [ ] Support for multiple DBMS (MySQL, SQLite, etc.)
• [ ] Plugin/Extension system
• [ ] Export/Import workspace
• [ ] Multi-language support (i18n)
• [ ] AI query assistant integration

See details at [CHANGELOG.md](CHANGELOG.md)

• 1.0.4: Updated UI, fixed layout bugs, optimized user experience.
• 1.0.2: First public release.

• Issues: [GitHub Issues](https://github.com/cin12211/orca-q/issues)
• Discussions: [GitHub Discussions](https://github.com/cin12211/orca-q/discussions)
• Email: taccin03@gmail.com

This project is licensed under the [MIT License](LICENSE).

• [Electron](https://www.electronjs.org/) - Build cross-platform desktop apps with JavaScript
• [Vue 3](https://vuejs.org/) - Progressive JavaScript framework
• [Vite](https://vitejs.dev/) - Next Generation Frontend Tooling
• [TypeScript](https://www.typescriptlang.org/)
• [Zod](https://zod.dev/) - TypeScript-first schema validation
• [@vueuse/core](https://vueuse.org/) - Vue Composition API utilities
• Icon design: [Figma Community](https://www.figma.com/design/wAm0jjPdhpKsEGXjtUw3tk/macOS-App-Icon-Template--Community-?node-id=102-4&t=B0v343GshmaCBMqU-0)
• Contributions from the open-source community

Many thanks to the kind individuals who leave a star.

Your support is much appreciated!

[](https://github.com/cin12211/orca-q/stargazers)

> _Made with ❤️ by the OrcaQ team and open-source contributors._