neon-js

Sets up the full Neon JS SDK with unified auth and PostgREST-style database queries. Configures auth client, data client, and type generation. Use when…

npx skills add https://github.com/neondatabase/ai-rules --skill neon-js

Neon JS SDK Integration

Set up the unified Neon JS SDK for authentication and database queries in one package.

When to Use This Skill

  • Building apps that need both auth and database queries
  • Migrating from Supabase to Neon
  • Using PostgREST-style API for database access
  • Need type-safe database queries with generated types

Package: @neondatabase/neon-js (full SDK with auth + data API)

Need auth only? Use the neon-auth skill instead for @neondatabase/auth with a smaller bundle.

Code Generation Rules

When generating TypeScript/JavaScript code, follow these rules:

Complete reference: See Code Generation Rules for:

  • Import path handling (path aliases vs relative imports)
  • Neon package imports (subpath exports, adapter patterns)
  • CSS import strategy (Tailwind detection, single import method)
  • File structure patterns

Key points:

  • Check tsconfig.json for path aliases before generating imports
  • Use relative imports if unsure or no aliases exist
  • BetterAuthReactAdapter MUST be imported from auth/react/adapters subpath
  • Adapters are factory functions - call them with ()
  • Choose ONE CSS import method (Tailwind or CSS, not both)

Available Guides

Each guide is a complete, self-contained walkthrough with numbered phases:

  • guides/setup.md - Complete setup guide for Next.js with auth + data API

I'll automatically detect your context (package manager, framework, existing setup) and select the appropriate guide based on your request.

For troubleshooting, see the Troubleshooting Guide in references.

Quick Examples

Tell me what you're building - I'll handle the rest:

  • "Set up Neon JS for my Next.js app" -> Loads full stack guide, configures auth + data
  • "Add database queries to my auth setup" -> Configures data API client
  • "Migrate from Supabase" -> Uses SupabaseAuthAdapter for compatibility

Reference Documentation

Primary Resource: See neon-js.mdc for comprehensive guidelines including:

  • Client setup for all frameworks
  • Database query patterns (PostgREST syntax)
  • Auth adapter options (BetterAuth, Supabase)
  • Type generation
  • Error handling

Auth Details: See neon-auth.mdc for:

  • All authentication methods
  • UI components
  • Session management

Framework-Specific Setup (choose your framework):

Framework-Specific UI (choose your framework):

Data API & Shared References:

Templates

  • templates/full-client.ts - Unified auth + data client configuration

Related Skills

  • neon-auth - Auth only (smaller bundle, no data queries)
  • neon-drizzle - Drizzle ORM setup (alternative to PostgREST)
  • neon-serverless - Direct database connections
  • add-neon-docs - Add Neon best practices to your project (run after setup)

Workflow

I will:

  1. Detect your project context automatically (Next.js, React SPA, Node.js)
  2. Select and load the appropriate guide
  3. Follow the guide's phases sequentially
  4. Track progress using the guide's workflow checklist
  5. Load reference files only when needed
  6. Offer to add Neon best practices to your project docs

Ready to get started? Just describe what you're building!

More skills from neondatabase

claimable-postgres
neondatabase
Instant Postgres databases for local development, demos, prototyping, and test environments. No account required. Databases expire after 72 hours unless claimed to a Neon account.
neon
neondatabase
Overview of the Neon platform for apps and agents, spanning Postgres, Auth, Data API, and the new services: Object Storage, Compute Functions, and AI Gateway. Use whenever "Neon" is mentioned for an overview of how to work with Neon and how to get started. Otherwise, the individual capabilities are the triggers: "object storage" or "S3-compatible storage", "serverless functions", "background jobs", or "run code near my database", "AI gateway", "LLM proxy", "model routing", or "call an LLM" →...
apidatabasedevelopment
plugin-manager
neondatabase
Manage plugin structure and configuration for this repository across both Cursor and Claude Code. Use when creating, updating, or reviewing plugin folders…
skill-creator
neondatabase
Guide for creating effective skills. This skill should be used when users want to create a new skill (or update an existing skill) that extends Claude's…
using-neon
neondatabase
Guides and best practices for working with Neon Serverless Postgres. Covers getting started, local development with Neon, choosing a connection method, Neon…
neon-js-react
neondatabase
Sets up the full Neon SDK with authentication AND database queries in React apps (Vite, CRA). Creates typed client, generates database types, and configures…
postgres-best-practices
neondatabase
Best practices and guidelines for working with Postgres. Covers schema design, indexing strategies, query optimization, migrations, and common pitfalls. Use…
neon-postgres-egress-optimizer
neondatabase
Guide the user through diagnosing and fixing application-side query patterns that cause excessive data transfer (egress) from their Postgres database. Most high egress bills come from the application fetching more data than it uses.