Installation

Clone the Repository

git clone https://github.com/htmujahid/supasheet.git
cd supasheet

Install Dependencies

npm install

pnpm install

yarn install

Set Up Supabase

You can use either a local Supabase instance or a cloud project.

Option 1: Local Development (Recommended)

Start a local Supabase instance:

npx supabase start

This will start Supabase on http://127.0.0.1:54321 and provide you with:

• API URL
• Publishable Key
• Studio URL: http://127.0.0.1:54323

Option 2: Cloud Project

1. Create a project at supabase.com
2. Get your API URL and keys from project settings

Configure Environment Variables

Create a .env file in the root directory:

# Supabase Configuration
VITE_SUPABASE_URL=http://127.0.0.1:54321
VITE_SUPABASE_PUBLISHABLE_KEY=your-publishable-key

Replace the Supabase values with your actual credentials.

Run Database Migrations

Apply the database schema:

npx supabase db reset

npx supabase db push

Expose Supasheet Schema

For Supasheet to work, you need to expose the supasheet schema via the PostgREST API. The public schema is already exposed by default.

Add the supasheet schema to /supabase/config.toml:

[api]
schemas = ["public", "supasheet"]

What this means:

• public - Your application tables (exposed by default)
• supasheet - All Supasheet internal tables including accounts, roles, permissions, dashboards, charts, and reports - Required

npx supabase stop
npx supabase start

Generate TypeScript Types

npm run typegen

This generates type definitions from your database schema.

Start Development Server

npm run dev

Open http://localhost:3000 in your browser.