Skip to content

heyjan/openbase

Repository files navigation

Openbase Logo

Openbase

Nuxt 4 Vue 3 TypeScript PostgreSQL Playwright Docker and Podman

Openbase is an open-source analytics and business intelligence platform built for teams that need secure, flexible dashboards across multiple data sources.

It focuses on practical admin workflows: controlled editor permissions, governed write access, shareable dashboards, and production-oriented security defaults.

Product Preview

Openbase admin home

Core Features

  • Guided first-run admin setup with magic link and password creation.
  • Role-based access control with separate admin and editor sessions.
  • Dashboard editor with drag/resize layout and configurable module types.
  • Controlled PostgreSQL write workflows via admin-managed writable tables.
  • Data-source integrations for PostgreSQL, MySQL, DuckDB, SQLite, and MongoDB.
  • Public dashboard sharing through tokenized links.
  • PDF export support for shared dashboards.
  • Audit logging and security hardening across auth and data-write flows.

Detailed capability breakdown: Feature Guide

Architecture

  • Frontend: Nuxt 4 + Vue 3 (app/)
  • Backend APIs: Nuxt server routes (server/api/**)
  • Database schema: PostgreSQL SQL schema (db/schema.sql)
  • Static assets: public/
  • Technical documentation: documentation/

Quick Start (Podman)

cp .env.example .env
podman compose down
podman compose build
podman compose up

Then open http://localhost:3000 and complete setup.

Local Development

  1. Install dependencies:
npm install
  1. Configure environment:
cp .env.example .env
  1. Start the dev server:
npm run dev
  1. Build for verification:
npm run build

Testing

End-to-end tests use Playwright:

npm run test:e2e

Security Notes

  • Connection strings and credentials must be provided through environment variables.
  • OPENBASE_ENCRYPTION_KEY is required in production for encrypted data-source settings.
  • Do not commit secrets or production credentials.

Documentation

  • Product specs: documentation/spec.md
  • Feature guide: documentation/features.md
  • Security and RBAC planning: documentation/database-integration-rbac-spec.md

About

An Open Source Metabase alternative

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages