cinny09/orca-q repository overview

⁠ OrcaQ - Next Generation database editor

⁠Orca Query

⁠Overview

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⁠, Vue 3⁠, TypeScript⁠, and Vite⁠, it targets developers, data engineers, analysts, DBAs, or anyone who needs to work with SQL/PostgreSQL data on the desktop.

⁠Features

• 🚀 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.

⁠Installation

⁠Requirements

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

⁠Steps (Web setup)

1. Clone the repository:

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

   Copy

2. Install dependencies:

   bun install
   

   Copy

3. Run in development mode:

   npm run nuxt:dev
   

   Copy

4. Build for production:

   npm run nuxt:build
   

   Copy

⁠Steps (App setup)

1. Clone the repository:

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

   Copy

2. Install dependencies:

   bun install
   

   Copy

3. Run in development mode:

   npm run dev
   

   Copy

4. Build for production:

   npm run app:build
   

   Copy

⁠Usage

• 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.

⁠Contributing

We welcome all contributions!

1. Fork the repo and create a new branch:

   git checkout -b feat/my-feature
   

   Copy

2. Follow commit conventions:

   • feat: ... Add a new feature
   • fix: ... Fix a bug
   • chore: ... Miscellaneous tasks
   • docs: ... Update documentation
   • refactor: ... Improve code without changing logic

3. Create a Pull Request:
   Clearly describe changes and link to relevant issues (if any).

4. Review & Merge:
   The core team will review and provide feedback promptly.

See more: CONTRIBUTING.md⁠

⁠Roadmap

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

⁠Changelog

See details at CHANGELOG.md⁠

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

⁠Community / Contact

• Issues: GitHub Issues⁠
• Discussions: GitHub Discussions⁠
• Email: [email protected]⁠

⁠License

This project is licensed under the MIT License⁠.

⁠Acknowledgements

• Electron⁠ - Build cross-platform desktop apps with JavaScript
• Vue 3⁠ - Progressive JavaScript framework
• Vite⁠ - Next Generation Frontend Tooling
• TypeScript⁠
• Zod⁠ - TypeScript-first schema validation
• @vueuse/core⁠ - Vue Composition API utilities
• Icon design: Figma Community⁠
• Contributions from the open-source community

⁠⭐ Stargazers

Many thanks to the kind individuals who leave a star. Your support is much appreciated!