An open API service indexing awesome lists of open source software.

https://github.com/polarbase-team/polarbase

Extensible Open-source Data Backend for PostgreSQL. Features a multi-view UI (Spreadsheet, Dashboard, Calendar), AI-Agent integration via MCP, and zero vendor lock-in.
https://github.com/polarbase-team/polarbase

ai-agents angular backend-as-a-service bun developer-tools elysiajs low-code mcp-server multi-view-ui open-source postgresql realtime-database spreadsheet typescript

Last synced: 30 days ago
JSON representation

Extensible Open-source Data Backend for PostgreSQL. Features a multi-view UI (Spreadsheet, Dashboard, Calendar), AI-Agent integration via MCP, and zero vendor lock-in.

Awesome Lists containing this project

README

          


PolarBase


PolarBase
✨ ✨ ✨

Open-source Extensible Data Backend

Multi-view UI • Agent-ready • Zero Lock-in • Postgre-native



[![GitHub stars](https://img.shields.io/github/stars/polarbase-team/polarbase?style=social)](https://github.com/polarbase-team/polarbase/stargazers)
[![GitHub license](https://img.shields.io/github/license/polarbase-team/polarbase)](https://github.com/polarbase-team/polarbase/blob/main/LICENSE)

## 1. Introduction

**Polarbase** is an open-source **Extensible Data Backend** built directly on the PostgreSQL core. It empowers developers to architect, manage, and scale complex databases with ease, combining enterprise-grade reliability with a modern, developer-centric experience.

**Architect your database with an intuitive UI and deploy data-driven solutions in minutes.**

[Explore Demo](https://polarbase-client.onrender.com) • [View Roadmap](./ROADMAP.md) • [Changelog](./CHANGELOG.md)

---

### Why Polarbase?

- **Multi-View Workspace:** Go beyond standard tables. **Structure** your data through specialized interfaces—**Spreadsheet** for rapid editing, **Dashboards** for real-time insights, and **Operational Views** (Forms/Calendars/Maps) for seamless workflows.
- **Built for Extensibility:** Designed as a core foundation, not a closed silo. With upcoming **SDKs** and native **MCP (Model Context Protocol)** support, Polarbase is engineered to power both custom frontends and autonomous AI Agents.
- **Pure PostgreSQL, Zero Lock-in:** We respect your data. By using SQLite exclusively for metadata, your PostgreSQL database remains clean, independent, and free from platform-specific overhead.
- **Developer-Centric & Agile:** Optimized for **data-intensive applications** that demand high performance and minimal backend overhead without sacrificing the power of a professional-grade engine.

---

> **Polarbase is currently in Public Beta.** > We are actively building the future of extensible backends. Please **Star** and **Watch** the repo for updates!

## 2. Screenshots



Spreadsheet UI (Data View)




Calendar View






Map View




AI Agent Interface






Diversity of Data Types




API Keys Management



## 3. Key Features

- **REST API for DB**: Secure and efficient API endpoints to interact with your PostgreSQL database.
- **AI Agent for DB**: Intelligent agent to assist with database operations. Focuses on data reasoning and operational assistance.
- **MCP Server for DB**: Model Context Protocol server for streamlined administration.
- **Realtime for DB**: Real-time updates and synchronization for dynamic data handling (via WebSocket or SSE).
- **Multi-View**: User-friendly spreadsheet-style interface for data visualization and manipulation, besides calendar, map views, etc.
- **API Key Management**: Generate API keys to grant controlled access to key features.

## 4. Tech Stack

- **Database**: PostgreSQL (>= 14.0)
- **Runtime**: Bun (>= 1.0)
- **Backend Framework**: Elysia (>= 1.0)
- **Frontend Framework**: Angular (>= 17.0)
- **AI Integration**: Google Gemini (default) or OpenAI
- **Languages**: TypeScript (>= 5.0), HTML, SCSS

## 5. Getting Started

### Cloud Version (Quick Try)

Visit our [hosted demo](https://polarbase-client.onrender.com) to explore without installation.

### Install Bun

Bun is a fast all-in-one JavaScript runtime that significantly outperforms Node.js in startup time, HTTP throughput, and package installation—often 2-4x faster (see benchmarks: [Bun.sh](https://bun.sh), [Strapi comparison](https://strapi.io/blog/bun-vs-nodejs-performance-comparison-guide), and [Better Stack guide](https://betterstack.com/community/guides/scaling-nodejs/nodejs-vs-deno-vs-bun/)).

Install it quickly by following the official instructions: [https://bun.sh/docs/installation](https://bun.sh/docs/installation)

### Local Development

1. Clone the repository:

```bash
git clone https://github.com/polarbase-team/polarbase.git
cd polarbase
```

2. Install dependencies using Bun:

```bash
bun install
```

3. Copy the example environment file:

```bash
cp server/.env.example server/.env
```

Then edit `server/.env` to add your configuration (API keys, database credentials, etc.).

4. Run the development servers:
- Both server and client from root:
```bash
bun start
```
- Or separately:
- Server (backend):
```bash
cd server
bun run dev
```
Runs on `http://localhost:3000`
- Client (frontend):
```bash
cd client
bun start
```
Runs on `http://localhost:4200`

Access the app at `http://localhost:4200` (frontend).

### Build for Production

```bash
bun run build
```

### Docker Support

Deploy easily with Docker Compose (recommended for production):

```bash
docker compose up --build
```

- Access at `http://localhost`.
- Customize with environment variables in `docker-compose.yml`.

For a custom setup:

```bash
docker run -e GEMINI_API_KEY= -p 3000:3000 polarbase-team/polarbase:latest
```

## 6. Configuration

- **API Keys for AI**: Polarbase supports multiple AI providers (Gemini, OpenAI, Anthropic, xAI). Add your keys (e.g., `GEMINI_API_KEY=your_key`) to the `.env` file in the `server` folder.
- **Local Models (LM Studio)**: Run models locally using [LM Studio](https://lmstudio.ai/):
1. Install LM Studio and download your preferred model.
2. Start the **Local Server** in LM Studio (default port: `1234`).
3. Polarbase defaults to `http://localhost:1234/v1`. Customize via `LOCAL_LLM_BASE_URL` in `.env` if needed.
4. In the Polarbase UI, open the Chatbot and select **Local** from the model menu.
- **PostgreSQL Connection**: Configured in the `server/.env` file. Set your `POSTGRES_HOST`, `POSTGRES_USER`, `POSTGRES_PASSWORD`, etc., to match your database setup.
- **Super Admin Key**: Use the super admin key for initial login and administration. Generate or set it in the `.env` file as `SUPER_ADMIN_API_KEY=your_secure_key_here`. This key is required to access admin features and manage API keys.
- **API Key Generation**: Once logged in as super admin, generate API keys via the interface to control access to features like REST API or AI agent.

**Privacy Note**: Polarbase does not store your database credentials. All operations run locally or in your controlled environment.

## 7. Try It Out

1. Go to the [app](https://polarbase-client.onrender.com).
2. Connect your PostgreSQL database.
3. Use the REST API or AI agent for operations.
4. Explore realtime features and spreadsheet-UI for data management.
5. Generate API keys to manage access.

## 8. Libraries & Technologies Used

- **Knexjs**: For type-safe database querying and migrations.
- **ai-sdk**: Integration for AI agents and providers (Gemini, OpenAI).
- **fastmcp**: Efficient implementation of the Model Context Protocol server.
- **PrimeNG**: Rich set of UI components for Angular.
- **Tailwind CSS**: Utility-first CSS framework for rapid styling.
- **Leaflet**: Open-source JavaScript library for mobile-friendly interactive maps.
- **FullCalendar**: The most popular JavaScript Calendar.
- Other dependencies: WebSocket libraries for realtime updates, Angular modules for frontend, and more (see `package.json` files in `client` and `server` for the full list).

## 9. Community & Support

- **[GitHub Issues](https://github.com/polarbase-team/polarbase/issues)**: Report bugs or request features.

## 10. Contributing

We welcome contributions! Whether it's fixing bugs, adding features, or improving docs.

- See our [Contributing Guide](./CONTRIBUTING.md) for details.
- Follow the [Code of Conduct](./CODE_OF_CONDUCT.md).

Fork the repo, create a branch, and submit a Pull Request—we'll review it ASAP.

## 11. License

Polarbase is licensed under the [MIT License](./LICENSE).

---

Made with ❤️ by the **polarbase-team**.
If you like the project, give it a ⭐ on GitHub! 😊