backend-dev-guidelines
π OPINIONATED SCAFFOLD: Modern Supabase + Edge Functions stack
Default Stack:
- Backend: Supabase Edge Functions (Deno runtime)
- Database: Supabase PostgreSQL + Row-Level Security
- Auth: Supabase Auth (JWT-based)
- Storage: Supabase Storage
- Email: Resend (transactional emails)
- Payments: Stripe (subscriptions + one-time)
- Language: TypeScript
- Deployment: Git push to Supabase
To customize: Run
/customize-scaffold backendor use the scaffold-customizer agent to adapt for Express, NestJS, Fastify, Django, Rails, Go, or other frameworks.
Backend Development Guidelines
Purpose
Establish consistency and best practices for Supabase-powered backends using Edge Functions, PostgreSQL with Row-Level Security, and TypeScript. This skill covers database design, authentication flows, API patterns, email integration, and payment processing.
When to Use This Skill
Automatically activates when working on:
- Creating or modifying Supabase Edge Functions
- Designing PostgreSQL database schemas
- Implementing Row-Level Security (RLS) policies
- Building authentication flows with Supabase Auth
- Integrating Supabase Storage for file uploads
- Sending transactional emails with Resend
- Processing payments with Stripe
- Input validation with Zod
- Testing with Supabase CLI
- Backend deployment and configuration
Quick Start
New Edge Function Checklist
- Function: Create in
supabase/functions/[name]/index.ts - Validation: Zod schema for input
- Auth: JWT verification with Supabase client
- Database: Use Supabase client with RLS
- Error handling: Try/catch with proper responses
- CORS: Configure allowed origins
- Tests: Local testing with Supabase CLI
- Deploy:
supabase functions deploy [name]
New Feature Checklist
- Database: Create migration with schema changes
- RLS: Add appropriate security policies
- Edge Function: Implement API endpoint
- Frontend Integration: Update Supabase client calls
- Testing: Test locally before deploy
- Monitoring: Check logs after deployment
Architecture Overview
Supabase Stack Architecture
HTTP Request
β
Edge Function (Deno runtime)
β
Supabase Client (Auth + validation)
β
PostgreSQL Database (with RLS)
β
Response with JSON
Key Principle: Edge Functions are stateless, RLS enforces data security.
Integrations:
- Supabase Auth β JWT-based authentication
- Supabase Storage β File uploads and CDN
- Supabase Realtime β WebSocket subscriptions
- Resend β Transactional emails
- Stripe β Payment processing
See architecture-overview.md for complete details.
Directory Structure
project/
βββ supabase/
β βββ functions/ # Edge Functions
β β βββ create-user/
β β β βββ index.ts
β β βββ send-email/
β β β βββ index.ts
β β βββ process-payment/
β β βββ index.ts
β βββ migrations/ # Database migrations
β β βββ 001_initial_schema.sql
β β βββ 002_add_rls.sql
β β βββ 003_add_indexes.sql
β βββ seed.sql # Test data
β βββ config.toml # Supabase config
βββ lib/
β βββ supabase/
β βββ client.ts # Supabase client setup
β βββ auth.ts # Auth utilities
β βββ types.ts # Database types
βββ types/
βββ database.types.ts # Generated from schema
Naming Conventions:
- Edge Functions:
kebab-case-create-user,send-email - Database tables:
snake_case-user_profiles,subscription_plans - RLS policies:
snake_case-users_select_own,posts_insert_authenticated - TypeScript types:
PascalCase-UserProfile,SubscriptionPlan
Core Principles (7 Key Rules)
1. Edge Functions are Simple and Focused
// β NEVER: 500-line Edge Function
Deno.serve(async (req) => {
// Massive logic...
});
// β
ALWAYS: Focused, single-purpose functions
Deno.serve(async (req) => {
const user = await getUserFromRequest(req);
const result = await createPost(user.id, req);
return new Response(JSON.stringify(result), { status: 201 });
});
2. Always Verify JWT Tokens
import { createClient } from '@supabase/supabase-js';
const supabase = createClient(
Deno.env.get('SUPABASE_URL')!,
Deno.env.get('SUPABASE_ANON_KEY')!,
{
global: {
headers: { Authorization: req.headers.get('Authorization')! }
}
}
);
const { data: { user }, error } = await supabase.auth.getUser();
if (error || !user) {
return new Response('Unauthorized', { status: 401 });
}
3. Use RLS for Data Security
-- Enable RLS on all tables
ALTER TABLE posts ENABLE ROW LEVEL SECURITY;
-- Users can only read their own data
CREATE POLICY "users_select_own" ON posts
FOR SELECT
USING (auth.uid() = user_id);
-- Users can only insert their own data
CREATE POLICY "posts_insert_own" ON posts
FOR INSERT
WITH CHECK (auth.uid() = user_id);
4. Validate All Input with Zod
import { z } from 'zod';
const CreatePostSchema = z.object({
title: z.string().min(1).max(200),
content: z.string().min(1),
tags: z.array(z.string()).optional()
});
const body = await req.json();
const validated = CreatePostSchema.parse(body); // Throws if invalid
5. Use Environment Variables via Deno.env
// β NEVER: Hardcode secrets
const apiKey = 'sk_live_abc123';
// β
ALWAYS: Use environment variables
const apiKey = Deno.env.get('STRIPE_API_KEY')!;
const resendKey = Deno.env.get('RESEND_API_KEY')!;
6. Handle Errors Gracefully
try {
const result = await performOperation();
return new Response(JSON.stringify({ success: true, data: result }), {
status: 200,
headers: { 'Content-Type': 'application/json' }
});
} catch (error) {
console.error('Operation failed:', error);
return new Response(JSON.stringify({
success: false,
error: error.message
}), {
status: 500,
headers: { 'Content-Type': 'application/json' }
});
}
7. Test Locally Before Deploying
# Start Supabase locally
supabase start
# Test Edge Function locally
supabase functions serve create-user --env-file .env.local
# Run tests
curl -i http://localhost:54321/functions/v1/create-user \
-H "Authorization: Bearer YOUR_TOKEN" \
-d '{"email":"test@example.com"}'
Common Imports
// Supabase
import { createClient } from '@supabase/supabase-js';
import type { Database } from '../types/database.types.ts';
// Validation
import { z } from 'zod';
// Email (Resend)
import { Resend } from 'resend';
// Payments (Stripe)
import Stripe from 'stripe';
// CORS helper
import { corsHeaders } from '../_shared/cors.ts';
Quick Reference
HTTP Status Codes
| Code | Use Case |
|---|---|
| 200 | Success |
| 201 | Created |
| 204 | No Content (DELETE success) |
| 400 | Bad Request (validation error) |
| 401 | Unauthorized (no/invalid token) |
| 403 | Forbidden (valid token, no permission) |
| 404 | Not Found |
| 500 | Server Error |
Common Edge Function Patterns
Auth Check β Verify JWT, get user CRUD Operations β Create, Read, Update, Delete with RLS Email Sending β Resend integration Payment Processing β Stripe webhooks and charges File Upload β Supabase Storage integration
Anti-Patterns to Avoid
β Skipping JWT verification β Querying database without RLS β No input validation β Exposing secrets in code β Missing error handling β Deploying without local testing β Direct database access (bypassing RLS) β console.log for production errors (use proper logging)
Example Resource Files
π Note: This is a scaffold skill with example resources. The provided resources demonstrate the pattern - you should generate additional resources as needed for your specific project.
β Provided Examples
architecture-overview.md - Complete Supabase stack architecture edge-functions-guide.md - Edge Function patterns and deployment database-and-rls.md - Database design and RLS policies
π Generate On-Demand
When you need guidance on a specific topic, ask Claude to generate a resource file following the same pattern as the examples above. Common topics:
- Validation patterns - Zod schemas and error handling
- Auth patterns - JWT verification, session management
- Storage patterns - File uploads, CDN, signed URLs
- Email integration - Resend templates and sending
- Stripe integration - Payments, subscriptions, webhooks
- Testing guide - Local testing, integration tests
- Complete examples - Full working Edge Function examples
How to request: "Generate a resource file for [topic] following the pattern in architecture-overview.md"
Customization Instructions
For Your Tech Stack
Not using Supabase? Use the scaffold-customizer agent or manual replacement:
# Option 1: Automated
# Claude will detect your stack and offer to customize
# Option 2: Manual find-and-replace
Supabase β Your database (Prisma, TypeORM, etc.)
Edge Functions β Your backend (Express, NestJS, etc.)
PostgreSQL β Your database (MySQL, MongoDB, etc.)
RLS β Your auth strategy
For Your Domain
Replace the generic examples with your domain:
- Update "posts" table β your entities
- Update "users" β your user model
- Update business logic examples
For Your Patterns
Adapt the principles to your architecture:
- Keep security-first approach
- Keep validation patterns
- Keep error handling patterns
- Adjust structure to your needs
Related Skills
- frontend-dev-guidelines - Next.js + React patterns for Supabase integration
- memory-management - Track architectural decisions
- skill-developer - Meta-skill for creating and managing skills
Skill Status: SCAFFOLD β Line Count: < 500 β Progressive Disclosure: Example resources + generation instructions β