Skip to content

README.md

Latest commit

 

History

History
100 lines (72 loc) · 4 KB

README.md

File metadata and controls

100 lines (72 loc) · 4 KB
Jet Admin - PostgreSQL tables manager and admin dashboard | Product Hunt

🚀 Jet Admin

The ultimate PostgreSQL management and visualization platform.

License: MIT React Node.js Prisma

Explore Docs • Report Bug • Request Feature

✨ Overview

Jet Admin is an open-source, web-based platform designed to simplify PostgreSQL database management and data visualization. Whether you're a developer managing schemas or an analyst building real-time dashboards, Jet Admin provides a seamless, intuitive interface for all your database needs.

mackup_final

🛠️ Key Features

  • 🗄️ Database Management: Full DML support (Insert, Update, Delete, Select) with bulk operation capabilities. Powerful DDL tools to create, alter, and drop tables, views, and triggers.
  • 🔍 Advanced Querying: Execute PostgreSQL queries with ease. Includes support for JavaScript-based queries and REST API integrations.
  • 📊 Data Visualization: Build stunning, real-time dashboards using a drag-and-drop interface. Support for Line, Bar, Pie, Radar, and more chart types.
  • 🤖 AI Integration: Leverage LLMs for database chat and automated query generation.
  • 🛡️ Enterprise Security: Multi-tenant support with Firebase Authentication and granular role-based access control (RBAC).

🚀 Tech Stack

Frontend Backend Infrastructure
Framework: React 18, Vite Runtime: Node.js Database: PostgreSQL
UI Kits: Ant Design, MUI Framework: Express ORM: Prisma
Editor: Monaco Editor Auth: Firebase Admin Container: Docker
State: TanStack Table & Query AI: Vercel AI SDK Proxy: Nginx

🏁 Quick Start

Prerequisites

  • Node.js (v20+)
  • PostgreSQL
  • Firebase Project (for Auth)

Setup & Installation

  1. Clone the repository:

    git clone https://github.com/jet-labs/jet-admin.git
cd jet-admin

  2. Install dependencies:

    npm install

  3. Configure environment variables:

    • Copy .env.sample to .env in both apps/frontend and apps/backend.
    • Update the variables with your configuration.

  4. Initialize Database:

    npm run seed

  5. Start Development Servers:

    npm run start:all

The application will be available at http://localhost:5173.

📖 Documentation

For full documentation, including setup guides, architecture deep-dives, and API references, visit: 👉 Documentation Website

🤝 Contributing

We love contributions! Please read our Contributing Guide to learn how you can help improve Jet Admin.

  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 MIT License. See LICENSE for more information.

Built with ❤️ by the Jet Labs Team