https://github.com/htmujahid/supasheet-docs
The admin panel you've been waiting for
https://github.com/htmujahid/supasheet-docs
next nextjs react shadcn supabase
Last synced: 3 months ago
JSON representation
The admin panel you've been waiting for
- Host: GitHub
- URL: https://github.com/htmujahid/supasheet-docs
- Owner: htmujahid
- Created: 2025-10-06T07:35:20.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-10-06T07:59:01.000Z (9 months ago)
- Last Synced: 2025-10-06T09:41:07.057Z (9 months ago)
- Topics: next, nextjs, react, shadcn, supabase
- Language: MDX
- Homepage: https://supasheet.app
- Size: 619 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Supasheet Documentation
Official documentation for [Supasheet](https://github.com/htmujahid/supasheet) - a SQL-based admin panel and CMS built on top of Supabase.
## About Supasheet
Supasheet is a powerful, code-first admin panel where you primarily write SQL to define your entire application. It leverages Supabase's core features (PostgREST, Auth, Storage, RLS) and automatically generates UI based on your database schema.
### Key Features
- **CRUD Operations** - Define tables and views in SQL, get automatic UI
- **Authentication & Authorization** - Supabase Auth + PostgreSQL RLS
- **Charts & Dashboards** - Visualizations using SQL views
- **Reports** - Generate reports from SQL queries
- **Audit Logs** - Automatic change tracking with PostgreSQL triggers
- **Storage Management** - File upload/management with Supabase Storage
- **SQL Editor** - Built-in database management
## Development
Run the development server:
```bash
npm run dev
# or
pnpm dev
# or
yarn dev
```
Open http://localhost:3000 with your browser to see the result.
## Documentation Structure
The documentation is organized into three main sections:
### 📚 Guide (`/docs/guide`)
Learn how to use Supasheet as a framework:
- Installation & Quickstart
- SQL-First Philosophy
- CRUD Operations
- Database Schema & Data Types
- Authorization with RLS
- Charts, Dashboards & Reports
- Audit Logs & User Management
- Storage & SQL Editor
- Complete Examples
### 🚀 Self-Host (`/docs/self-host`)
Deploy Supasheet on your own infrastructure:
- Prerequisites
- Database Setup
- Deployment Options
- Internationalization
## Project Structure
- `content/docs/` - MDX documentation files
- `lib/source.ts` - Content source adapter using Fumadocs
- `lib/layout.shared.tsx` - Shared layout configuration
- `app/(home)` - Landing page and marketing pages
- `app/docs` - Documentation layout and pages
- `app/api/search/route.ts` - Search API route handler
## Technology Stack
- **Framework**: Next.js 15 (App Router)
- **Documentation**: [Fumadocs](https://fumadocs.dev)
- **Styling**: Tailwind CSS
- **Components**: Fumadocs UI
## Learn More
- [Supasheet Repository](https://github.com/htmujahid/supasheet)
- [Fumadocs Documentation](https://fumadocs.dev)
- [Next.js Documentation](https://nextjs.org/docs)