Noir

<p align="center"> <a href="https://github.com/invm/noir"> <img src="public/logo.svg" alt="Logo" width="120" height="120"> </a> <h1 align="center">Noir</h1> <p align="center"> Unleash the Power of Seamless Database Management – Navigate, Query, and Optimize, All at Your Fingertips <br/> <br/> <a href="https://noirdb.dev/"><strong>Explore the docs »</strong></a> <br/> <br/> <a href="https://github.com/invm/noir/issues">Report a Bug</a> . <a href="https://github.com/invm/noir/issues">Request a Feature</a> </p> </p>

Table Of Contents

• Table Of Contents
• About The Project
  • Supported databases
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
  • Creating A Pull Request
• License
• Authors

About The Project

<img src="public/app-showcase.png" alt="noir app showcase" width="100%">

Empower your database management experience with our keyboard-driven client! Free and open source, cross-platform, and designed for power developers.

Enjoy multiple connections, query tabs, export options, a sleek editor, and a lightning-fast grid – all accessible with the ease of keyboard shortcuts.

Unleash efficiency, tailor UI themes, and explore complex data effortlessly. Elevate your workflow with quick actions, making it the ultimate choice for developers.

Supported databases

• Postgresql
• MySQL
• MariaDB
• SQLite
• ClickHouse

Built With

• Tauri
• SolidJS
• Monaco Editor
• AG-Grid
• Shadcn for SolidJS

Full lists are available under package.json and src-tauri/Cargo.toml.

Getting Started

If you want to contribute or build for your arch that is not listed on the release page, you may clone this repo and run or build as you like.

Prerequisites

• Rust
• Node
• pnpm

Installation

Run pnpm install

Start the project with pnpm dev

Build for your os and arch with pnpm tauri build

Usage

Query, inspect, and export results all with your keyboard.

Noir is a database management client and you can do everything you would expect with it, full docs are available here.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the GPLv3 license. See LICENSE for more information.