NEXTY.DEV

https://nexty.dev/docs
Admin
NEXTY.DEV is a Next.js SaaS full-stack boilerplate providing complete infrastructure, built-in...
Tokens:75,884
Snippets:669
Trust Score:7.3
Update:7 months ago
Show doc for...
Tokens:
Raw
### Start Development Server

Source: https://nexty.dev/docs/start-project/setup

Starts the NEXTY.DEV development server using different package managers. This command allows you to view the application locally and test changes in real-time.

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
```

--------------------------------

### Install Project Dependencies with pnpm

Source: https://nexty.dev/docs/start-project/setup

Installs all necessary project dependencies using the pnpm package manager. This command should be run after navigating to the project directory.

```bash
pnpm install
```

--------------------------------

### Configure Local Environment Variables

Source: https://nexty.dev/docs/start-project/setup

Copies the example environment variables file to `.env.local` for local development configuration. This step is crucial for setting up the application's environment-specific settings.

```bash
cp .env.example .env.local
```

--------------------------------

### Install Dokploy via Script

Source: https://nexty.dev/docs/start-project/dokploy

This command installs Dokploy on your server by downloading and executing an installation script from the official Dokploy website. It's a straightforward way to get Dokploy up and running on your VPS.

```bash
curl -sSL https://dokploy.com/install.sh | sh
```

--------------------------------

### Create Frontend Display Pages for 'guide' Module (TypeScript/JSX)

Source: https://nexty.dev/docs/guide/cms

This snippet demonstrates how to set up frontend pages for a new 'guide' CMS module. It includes fetching posts and tags, and rendering a PostList component. It also shows how to fetch individual posts by slug and handle view count statistics and related posts.

```typescript
// Create CMS module instance (in lib/cms/index.ts)
export const guideCms = createCmsModule('guide');

// Use in page
const { posts: localPosts } = await guideCms.getLocalList(locale);

const initialServerPostsResult = await listPublishedPostsAction({
  pageIndex: 0,
  pageSize: SERVER_POST_PAGE_SIZE,
  postType: "guide", // Modify here
  locale: locale,
});

// Tags
const tagsResult = await listTagsAction({ postType: "guide" });

// PostList component
<PostList
  postType="guide"
  baseUrl="/guide"
  localPosts={localPosts}
  initialPosts={initialServerPosts}
  initialTotal={totalServerPosts}
  serverTags={serverTags}
  locale={locale}
  pageSize={SERVER_POST_PAGE_SIZE}
  showTagSelector={true}
  showCover={POST_CONFIGS.guide.showCoverInList}
  emptyMessage="No guides found for this tag."
/>

// Use guideCms to get content
const { post, errorCode } = await guideCms.getBySlug(slug, locale);

// View count statistics
const viewCountConfig = POST_CONFIGS.guide.viewCount;
if (viewCountConfig.enabled) {
  if (viewCountConfig.mode === "unique") {
    await incrementUniqueViewCountAction({ slug, postType: "guide", locale });
  } else {
    await incrementViewCountAction({ slug, postType: "guide", locale });
  }
}

// Related articles
<RelatedPosts
  postId={post.id}
  postType="guide"
  limit={10}
  title="Related Guides"
  locale={locale}
  CardComponent={GuidePostCard}
/>
```

--------------------------------

### Initialize Database and Schema Imports

Source: https://nexty.dev/docs/guide/auth-database/database

Demonstrates how to import the database client and schema definitions from the project's library directory.

```typescript
import { db } from '@/lib/db';
import { user, orders, pricingPlans, usage, creditLogs } from '@/lib/db/schema';
```

--------------------------------

### Navigate to Project Directory

Source: https://nexty.dev/docs/start-project/setup

Changes the current directory to the root of the cloned NEXTY.DEV repository. This command is essential after cloning to access project files and run subsequent commands.

```bash
cd your-fork-repo-name
```

--------------------------------

### Clone Repository using Git

Source: https://nexty.dev/docs/start-project/setup

Clones the NEXTY.DEV source repository to your local machine. You can clone it into the current directory or specify a new folder name. This is a prerequisite for local development.

```bash
git clone https://github.com/your-github-username/your-fork-repo-name.git

## or 

git clone https://github.com/your-github-username/your-fork-repo-name.git <new-folder-name>
```

--------------------------------

### Install GitHub CLI on Windows

Source: https://nexty.dev/docs/start-project/sync-env-to-github

Installs the GitHub CLI tool on Windows using either winget or scoop package managers. This is a prerequisite for interacting with GitHub from the command line.

```bash
winget install --id GitHub.cli

```

```bash
scoop install gh
```

--------------------------------

### Dockerfile for Nexty Dev Application

Source: https://nexty.dev/docs/start-project/dokploy

This Dockerfile defines the build process for the Nexty Dev application. It uses a multi-stage build approach, starting with dependency installation and then proceeding to the build stage. It also declares build arguments for various configurations, including Next.js specific variables, database URLs, and third-party service API keys.

```dockerfile
# ============================================
# Dependencies Stage
# ============================================
FROM node:20-alpine AS deps
WORKDIR /app

# Enable corepack (for managing package manager versions)
RUN corepack enable

# Copy package management files
COPY package.json pnpm-lock.yaml* ./

# Prefetch dependencies using cache mount
RUN --mount=type=cache,target=/root/.local/share/pnpm/store/v3 \
  pnpm fetch
# Install dependencies using cache mount (frozen lockfile, offline mode)
RUN --mount=type=cache,target=/root/.local/share/pnpm/store/v3 \
  pnpm install --frozen-lockfile --offline

# ============================================
# Build Stage
# ============================================
FROM node:20-alpine AS builder
WORKDIR /app

# Enable corepack
RUN corepack enable

# Copy node_modules from dependencies stage
COPY --from=deps /app/node_modules ./node_modules
# Copy all source code
COPY . .

# ============================================
# Build Arguments
# Only declare variables needed at build time
# ============================================

# NEXT_PUBLIC_* variables (will be embedded in client-side JavaScript)
ARG NEXT_PUBLIC_SITE_URL
ARG NEXT_PUBLIC_PRICING_PATH
ARG NEXT_PUBLIC_OPTIMIZED_IMAGES
ARG NEXT_PUBLIC_LOGIN_MODE
ARG NEXT_PUBLIC_GITHUB_CLIENT_ID
ARG NEXT_PUBLIC_GOOGLE_CLIENT_ID
ARG NEXT_PUBLIC_TURNSTILE_SITE_KEY
ARG NEXT_PUBLIC_ENABLE_STRIPE
ARG NEXT_PUBLIC_DEFAULT_CURRENCY
ARG NEXT_PUBLIC_GOOGLE_ID
ARG NEXT_PUBLIC_PLAUSIBLE_DOMAIN
ARG NEXT_PUBLIC_PLAUSIBLE_SRC
ARG NEXT_PUBLIC_DISCORD_INVITE_URL
ARG NEXT_PUBLIC_AUTO_FILL_AI_PROVIDER
ARG NEXT_PUBLIC_AUTO_FILL_AI_MODEL_ID
ARG NEXT_PUBLIC_DAILY_AI_AUTO_FILL_LIMIT
ARG NEXT_PUBLIC_DAILY_SUBMIT_LIMIT
ARG NEXT_PUBLIC_DAILY_IMAGE_UPLOAD_LIMIT

# R2_PUBLIC_URL is needed by next.config.mjs for image remotePatterns
ARG R2_PUBLIC_URL
ARG R2_ACCOUNT_ID
ARG R2_ACCESS_KEY_ID
ARG R2_SECRET_ACCESS_KEY
ARG R2_BUCKET_NAME

# DATABASE_URL is needed for static site generation (SSG) at build time
ARG DATABASE_URL

# BETTER_AUTH
ARG BETTER_AUTH_SECRET
ARG BETTER_AUTH_GITHUB_CLIENT_SECRET
ARG GOOGLE_CLIENT_SECRET

# STRIPE
ARG STRIPE_SECRET_KEY
ARG STRIPE_PUBLISHABLE_KEY
ARG STRIPE_WEBHOOK_SECRET
ARG STRIPE_CUSTOMER_PORTAL_URL

# RESEND
ARG RESEND_API_KEY
ARG ADMIN_EMAIL
ARG ADMIN_NAME

# UPSTASH
ARG UPSTASH_REDIS_REST_URL
ARG UPSTASH_REDIS_REST_TOKEN

# AI
ARG OPENROUTER_API_KEY
ARG FIRECRAWL_API_KEY

# PLAUSIBLE
ARG PLAUSIBLE_API_KEY
ARG PLAUSIBLE_URL

# DISCORD
ARG DISCORD_SUBMIT_WEBHOOK_URL

# ============================================
# Build Environment Variables
# ============================================

```

--------------------------------

### Initialize and Seed Database

Source: https://nexty.dev/docs/guide/auth-database/dev-examples

Commands to set up the initial database structure and populate it with sample seed data. This is typically the first step after setting up the project environment.

```bash
# Initialize database
npm run db:migrate
 
# Import sample pricing plan seed data
npm run db:seed
```

--------------------------------

### Multi-language and Benefits Configuration

Source: https://nexty.dev/docs/guide/payment/prices-card

Examples of JSONB structures used for storing localized content and plan-specific benefits like credit allocations.

```json
{
  "langJsonb": {
    "en": {
      "cardTitle": "Pro Plan",
      "displayPrice": "$29"
    },
    "zh": {
      "cardTitle": "专业版",
      "displayPrice": "¥199"
    }
  },
  "benefitsJsonb": {
    "oneTimeCredits": 100,
    "monthlyCredits": 50,
    "totalMonths": 12
  }
}
```

--------------------------------

### Execute Newsletter Welcome Email Action

Source: https://nexty.dev/docs/guide/send-email

Example usage of the sendEmail utility to trigger a newsletter welcome email. This demonstrates passing the template component and necessary props to the unified action.

```typescript
await sendEmail({
  email: normalizedEmail,
  subject: `Welcome to ${siteConfig.name} Newsletter!`,
  react: NewsletterWelcomeEmail,
  reactProps: {
    email: normalizedEmail,
    unsubscribeLink,
  },
});
```

--------------------------------

### Install GitHub CLI on MacOS

Source: https://nexty.dev/docs/start-project/sync-env-to-github

Installs the GitHub CLI tool on macOS using the Homebrew package manager. This is a prerequisite for interacting with GitHub from the command line.

```bash
brew install gh
```

--------------------------------

### Free Plan Configuration (JSON)

Source: https://nexty.dev/docs/guide/payment/prices-card

Configuration to set up a free plan by setting the `provider` to 'none'. A `buttonLink` can be provided to guide users.

```json
{
  "provider": "none",
  "buttonLink": "/features"
}
```

--------------------------------

### Initialize and Seed Database (npm)

Source: https://nexty.dev/docs/integration/database

Commands to initialize the database schema and import example seed data. These commands are typically run after setting up a new database connection.

```bash
# Initialize database
npm run db:migrate

# Import example pricing plan seed data
npm run db:seed
```

--------------------------------

### Execute Relational Queries with Joins

Source: https://nexty.dev/docs/guide/auth-database/database

Demonstrates how to perform left joins between tables to retrieve combined data sets.

```typescript
import { eq } from 'drizzle-orm';
 
const rows = await db
  .select({
    orderId: orders.id,
    planInterval: pricingPlans.recurringInterval,
    amount: orders.amountTotal,
  })
  .from(orders)
  .leftJoin(pricingPlans, eq(orders.planId, pricingPlans.id));
```

--------------------------------

### Implement PricingAll Component

Source: https://nexty.dev/docs/guide/payment/pricing-groups

Demonstrates the usage of the PricingAll component, which renders all active pricing plans in a flat grid layout without grouping.

```typescript
import { PricingAll } from "@/components/pricing";
 
export default function SimplePricingPage() {
  return <PricingAll />;
}
```

--------------------------------

### Open Database Visualization Tool

Source: https://nexty.dev/docs/guide/auth-database/dev-examples

Launches a local web-based interface for visual management of database tables and data. Useful for debugging and inspecting the database state.

```bash
npm run db:studio
```

--------------------------------

### Install and Update Supabase CLI

Source: https://nexty.dev/docs/integration/supabase

Commands to install or upgrade the Supabase CLI on macOS, Linux, and Windows systems using package managers like Homebrew or Scoop.

```shell
# mac OS or Linux
brew install supabase/tap/supabase

# Windows
scoop bucket add supabase https://github.com/supabase/scoop-bucket.git
scoop install supabase
```

```shell
# mac OS or Linux
brew upgrade supabase

# Windows
scoop update supabase
```

--------------------------------

### Example: Dynamically Determine Available Locales (TypeScript)

Source: https://nexty.dev/docs/guide/metadata-config

Demonstrates how to dynamically determine the available locales for a blog article by checking for its existence in different language versions. The results are then used to configure the 'availableLocales' metadata property.

```typescript
// Detect which languages have this article
const availableLocales: string[] = []
for (const checkLocale of LOCALES) {
  const post = await getPostBySlug(slug, checkLocale)
  if (post) availableLocales.push(checkLocale)
}
 
// Generate hreflang only for existing languages
constructMetadata({
  // ...
  availableLocales: availableLocales.length > 0 ? availableLocales : undefined,
})
```

--------------------------------

### Cron Expression Syntax Reference

Source: https://nexty.dev/docs/start-project/cron

A visual guide to the five-field cron expression format, detailing the allowed values for minutes, hours, days, months, and days of the week.

```text
┌───────────── minute (0 - 59)
│ ┌───────────── hour (0 - 23)
│ │ ┌───────────── day of month (1 - 31)
│ │ │ ┌───────────── month (1 - 12)
│ │ │ │ ┌───────────── day of week (0 - 6) (Sunday=0)
│ │ │ │ │
* * * * *
```

--------------------------------

### Configure Stricter Daily Login Rate Limits with Redis (TypeScript)

Source: https://nexty.dev/docs/guide/auth-database/rate-limiting

Implements stricter daily rate limits for authentication endpoints to prevent free tier abuse, utilizing Upstash Redis for persistent storage. This example sets daily limits for magic link requests, OTP code sending, and verification attempts, with automatic expiration.

```typescript
rateLimit: {
  enabled: true,
  window: 60,
  max: 100,
  customRules: {
    // Strict email sending limits
    "/sign-in/magic-link": { 
      window: 60 * 60 * 24, // 24 hours
      max: 5, // Only 5 magic links per IP per day
    },
    "/email-otp/send-verification-otp": { 
      window: 60 * 60 * 24, // 24 hours
      max: 10, // Only 10 OTP codes per IP per day
    },
    // Keep verification attempts reasonable
    "/sign-in/email-otp": { 
      window: 60 * 60 * 24, // 24 hours
      max: 20, // 20 attempts per 24 hours
    }
  },
  ...(redis && {
    customStorage: {
      get: async (key: string) => {
        const data = await redis!.get<{ key: string; count: number; lastRequest: number }>(key);
        return data || undefined;
      },
      set: async (key: string, value: { key: string; count: number; lastRequest: number }) => {
        await redis!.set(key, value, { ex: 60 * 60 * 24 }); // Auto-expire after 24 hours
      },
    },
  }),
}
```

--------------------------------

### Run Database Migration (Shell)

Source: https://nexty.dev/docs/guide/auth-database/rate-limiting

This command uses `pnpm dlx` to execute the Better Auth CLI's migration command. This is necessary when setting up database storage to create or update the required database tables for features like rate limiting.

```bash
pnpm dlx @better-auth/cli migrate
```

--------------------------------

### GET /actions/prices/public/getPublicPricingPlans

Source: https://nexty.dev/docs/guide/payment/prices-card

Retrieves all active pricing plans. The system automatically filters results based on the current environment (live vs test).

```APIDOC
## GET /actions/prices/public/getPublicPricingPlans

### Description
Fetches all active pricing plans filtered by the current environment.

### Method
GET

### Response
#### Success Response (200)
- **data** (array) - List of active pricing plans.

### Response Example
{
  "success": true,
  "data": [
    { "id": "plan-1", "cardTitle": "Pro Plan" }
  ]
}
```

--------------------------------

### Generate Better-auth Secret

Source: https://nexty.dev/docs/integration/auth

Generates a secure, base64-encoded 32-byte string required for the BETTER_AUTH_SECRET environment variable.

```bash
openssl rand -base64 32
```

--------------------------------

### Perform Basic Queries, Pagination, and Search

Source: https://nexty.dev/docs/guide/auth-database/database

Covers fetching single records, paginated lists with sorting, and filtering using Drizzle ORM operators like eq, ilike, and or.

```typescript
import { eq, ilike, or, desc } from 'drizzle-orm';
 
// Single record
const one = await db.select().from(user).where(eq(user.id, userId)).limit(1);
 
// List + pagination + sorting + search
const pageIndex = 0, pageSize = 20, keyword = 'john';
const cond = keyword
  ? or(ilike(user.email, `%${keyword}%`), ilike(user.name, `%${keyword}%`))
  : undefined;
 
const users = await db
  .select()
  .from(user)
  .where(cond)
  .orderBy(desc(user.createdAt))
  .offset(pageIndex * pageSize)
  .limit(pageSize);
 
// Total count (for pagination)
const totalCount = (await db.select({ value: count() }).from(user).where(cond))[0].value;
```

--------------------------------

### Export New CMS Module in lib/cms/index.ts (TypeScript)

Source: https://nexty.dev/docs/guide/cms

This snippet shows how to export a newly created CMS module, specifically the 'guide' module, by adding it to the `lib/cms/index.ts` file. This makes the module available for use throughout the application.

```typescript
// Add at the end of the file
export const guideCms = createCmsModule('guide');
```

--------------------------------

### Implement PricingByGroup Component

Source: https://nexty.dev/docs/guide/payment/pricing-groups

Demonstrates the usage of the PricingByGroup component for tabbed pricing displays and provides a logic pattern for filtering plans by custom group slugs.

```typescript
import { PricingByGroup } from "@/components/pricing";
 
export default function PricingPage() {
  return <PricingByGroup />;
}

// Example: Filter by custom groups
const basicPlans = allPlans.filter((plan) => plan.groupSlug === "basic");
const proPlans = allPlans.filter((plan) => plan.groupSlug === "pro");
const enterprisePlans = allPlans.filter((plan) => plan.groupSlug === "enterprise");
```

--------------------------------

### Implement constructMetadata for Next.js Pages

Source: https://nexty.dev/docs/guide/metadata-config

Demonstrates the implementation of generateMetadata using the constructMetadata helper. Covers standard page setups, handling multilingual content, dynamic data fetching, and SEO configurations such as canonical URLs and no-index rules.

```typescript
export async function generateMetadata({ params }: MetadataProps): Promise<Metadata> {
  const { locale } = await params;
  const t = await getTranslations({ locale, namespace: 'Home' });
  
  return constructMetadata({
    title: t('title'),
    description: t('description'),
    locale: locale as Locale,
    path: '/',
  });
}
```

```typescript
export async function generateMetadata({ params }: MetadataProps): Promise<Metadata> {
  const { slug } = await params;
  const result = await getProductBySlug(slug);
 
  if (!result.success || !result.data) {
    return constructMetadata({
      title: "404",
      description: "Product not found",
      noIndex: true,
      path: `/product/${slug}`,
    });
  }
 
  return constructMetadata({
    title: result.data.name,
    description: result.data.tagline,
    path: `/product/${slug}`,
    useDefaultOgImage: false,
  });
}
```

```typescript
export async function generateMetadata({ params }: MetadataProps): Promise<Metadata> {
  const { locale } = await params;
  
  return constructMetadata({
    title: "Start Your Free Trial",
    description: "Try all features for free.",
    locale: locale as Locale,
    path: "/free-trial",
    canonicalUrl: "/pricing",
  });
}
```

--------------------------------

### Manage Server-side Sessions and Authorization

Source: https://nexty.dev/docs/guide/auth-database/auth

Demonstrates how to retrieve user sessions, validate admin roles, and protect server actions or routes using the internal auth library.

```typescript
import { getSession } from "@/lib/auth/server";
 
export async function SomeServerActions(req: Request) {
  const session = await getSession()
  const user = session?.user;
  if (!user) return actionResponse.unauthorized();
 
  return actionResponse.success({});
}
```

```typescript
import { isAdmin } from "@/lib/auth/server";
 
export async function SomeAdminServerActions() {
  if (!(await isAdmin())) return actionResponse.forbidden('Admin privileges required.')
}
```

--------------------------------

### HTML Metadata Example

Source: https://nexty.dev/docs/guide/metadata-config

This snippet demonstrates the structure of HTML metadata within the `<head>` tag, including title, description, Open Graph tags, canonical, and hreflang attributes. This metadata is essential for search engine optimization and social media sharing.

```html
<head>
  <title>NEXTY.DEV - Build and ship your SaaS faster</title>
  <meta name="description" content="Next.js SaaS starter template..." />
  <meta property="og:title" content="NEXTY.DEV" />
  <meta property="og:image" content="https://nexty.dev/og.png" />
  <link rel="canonical" href="https://nexty.dev/" />
  <link rel="alternate" hreflang="en-US" href="https://nexty.dev/" />
  <link rel="alternate" hreflang="zh-CN" href="https://nexty.dev/zh" />
</head>
```

--------------------------------

### Local Webhook Testing with ngrok

Source: https://nexty.dev/docs/guide/payment/webhook-handling

Demonstrates how to expose a local development server to the public network using ngrok, enabling external services like Creem to send webhooks to your local machine. After starting ngrok, the provided URL is used to configure the webhook in the Creem dashboard.

```bash
ngrok http 3000
# Use the URL provided by ngrok to configure the webhook
```

--------------------------------

### Stripe CLI Webhook Testing Commands

Source: https://nexty.dev/docs/guide/payment/webhook-handling

Provides commands to set up and test Stripe webhooks locally using the Stripe CLI. This involves installing the CLI, logging in, forwarding webhooks to a local endpoint (e.g., `localhost:3000/api/stripe/webhook`), and triggering test events like `checkout.session.completed`.

```bash
# Install Stripe CLI
brew install stripe/stripe-cli/stripe

# Login
stripe login

# Forward webhooks to local
stripe listen --forward-to localhost:3000/api/stripe/webhook

# Trigger test event
stripe trigger checkout.session.completed
```

--------------------------------

### Generate and Apply Database Migrations

Source: https://nexty.dev/docs/guide/auth-database/dev-examples

The standard workflow for updating the database schema. Developers modify the schema definition file and then use these commands to generate and apply migration files to the database.

```bash
# Generate migration file based on schema changes
npm run db:generate

# Push migration to the database
npm run db:migrate
```

--------------------------------

### Handle Client-side Authentication

Source: https://nexty.dev/docs/guide/auth-database/auth

Provides methods for managing user sessions, social logins, magic links with CAPTCHA, and Google One Tap on the client side.

```typescript
import { authClient } from "@/lib/auth/auth-client";

// Get session
const { data: session, isPending } = authClient.useSession();

// Social Login
await authClient.signIn.social({ provider: "google", callbackURL: window.location.origin });

// Sign Out
await authClient.signOut({ fetchOptions: { onSuccess: () => router.refresh() } });

// Get Last Method
const lastLogin = authClient.getLastUsedLoginMethod();
```

```typescript
import { Turnstile } from "@marsidev/react-turnstile";

// Magic Link with CAPTCHA
<Turnstile siteKey={process.env.NEXT_PUBLIC_TURNSTILE_SITE_KEY!} onSuccess={(token) => setCaptchaToken(token)} />

await authClient.signIn.magicLink({
  email,
  fetchOptions: { headers: { "x-captcha-response": captchaToken } },
});
```

```typescript
import { authClient } from "@/lib/auth/auth-client";

// Google One Tap
await authClient.oneTap({
  fetchOptions: { onSuccess: () => window.location.reload() }
});
```

--------------------------------

### Import Resend Client Instance

Source: https://nexty.dev/docs/guide/send-email

How to import the pre-configured Resend client instance within your application files. Note that direct usage is discouraged in favor of the unified sendEmail action.

```typescript
import resend from '@/lib/resend';
```

--------------------------------

### Configure DNS Records for Dokploy Custom Domain

Source: https://nexty.dev/docs/start-project/dokploy

These are example DNS records to configure for your custom domain to point to your Dokploy server. It involves setting up A records for both the root domain and the 'www' subdomain, pointing them to your server's IP address and enabling proxying.

```dns
A record:
your-domain.com -> Your server IP
Enable Proxy
 
A record:
www.your-domain.com -> Your server IP
Enable Proxy
```

--------------------------------

### Configure Umami Environment Variables (.env)

Source: https://nexty.dev/docs/integration/tracking/umami

Set the NEXT_PUBLIC_UMAMI_SRC and NEXT_PUBLIC_UMAMI_WEBSITE_ID environment variables in your .env file to enable Umami analytics. The SRC points to the Umami script endpoint, and WEBSITE_ID is your unique Umami website identifier.

```env
NEXT_PUBLIC_UMAMI_SRC=https://your-umami.com/script.js
NEXT_PUBLIC_UMAMI_WEBSITE_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
```

--------------------------------

### Implement dashboard management pages

Source: https://nexty.dev/docs/guide/cms

Shows how to initialize the data table and editor components for a new module by setting the appropriate postType.

```tsx
const result = await listPostsAction({
  pageIndex: 0,
  pageSize: PAGE_SIZE,
  postType: "guide",
});

<PostDataTable
  config={{
    postType: "guide",
    columns,
    listAction: listPostsAction,
    createUrl: "/dashboard/guides/new",
    enableTags: true,
    searchPlaceholder: "Search guides...",
  }}
/>

<PostEditorClient
  postType="guide"
  mode="create"
  r2PublicUrl={r2PublicUrl}
  postId={postId}
/>
```

--------------------------------

### Configure Upstash Redis for Custom Storage (TypeScript)

Source: https://nexty.dev/docs/guide/auth-database/rate-limiting

This snippet shows how to configure Upstash Redis for custom storage in the Nexty Dev authentication library. It defines `get` and `set` functions to interact with Redis, including setting an expiration time for keys. This is recommended for production environments due to data persistence and scalability.

```typescript
...(redis && {
  customStorage: {
    get: async (key: string) => {
      const data = await redis!.get<{ key: string; count: number; lastRequest: number }>(key);
      return data || undefined;
    },
    set: async (key: string, value: { key: string; count: number; lastRequest: number }) => {
      await redis!.set(key, value, { ex: 120 }); // Auto-expire after 120 seconds
    },
  },
}),
```

--------------------------------

### Update sitemap.ts for New Module Routes (TypeScript)

Source: https://nexty.dev/docs/guide/cms

This snippet illustrates how to update the `app/sitemap.ts` file to include routes for the new 'guide' CMS module. It adds entries for both the main guide list page and individual guide detail pages, ensuring proper SEO indexing.

```typescript
// Add guide list page
{
  url: `${siteUrl}/${locale}/guide`,
  lastModified: new Date(),
  changeFrequency: 'daily',
  priority: 0.8,
}

// Add guide detail pages
const guideResult = await listPublishedPostsAction({
  locale: locale,
  pageSize: 1000,
  visibility: "public",
  postType: "guide",
});

if (guideResult.success && guideResult.data?.posts) {
  guideResult.data.posts.forEach((post) => {
    sitemap.push({
      url: `${siteUrl}/${locale}/guide/${post.slug}`,
      lastModified: post.updatedAt ? new Date(post.updatedAt) : new Date(),
      changeFrequency: 'weekly',
      priority: 0.7,
    });
  });
}
```

--------------------------------

### POST /actions/prices/admin/createPricingPlanAction

Source: https://nexty.dev/docs/guide/payment/prices-card

Creates a new pricing plan with specified configuration, including multi-language support and benefit definitions.

```APIDOC
## POST /actions/prices/admin/createPricingPlanAction

### Description
Creates a new pricing plan entry in the database.

### Method
POST

### Parameters
#### Request Body
- **planData** (object) - Required - The pricing plan details including environment, provider, price, and localized content.
- **locale** (string) - Required - The language code for the plan content.

### Request Example
{
  "planData": {
    "environment": "live",
    "cardTitle": "Pro Plan",
    "price": "29.00",
    "currency": "USD",
    "isActive": true
  },
  "locale": "en"
}
```

--------------------------------

### GitHub Actions Workflow for Docker Image Build and Push

Source: https://nexty.dev/docs/start-project/dokploy

This GitHub Actions workflow automates the process of building and pushing Docker images to a container registry. It checks out the repository, logs into the registry, extracts image metadata, sets up Docker Buildx, and then builds and pushes the image. It utilizes environment variables and secrets for registry credentials and build arguments.

```yaml
name: Create and publish a Docker image

on:
  push:
    branches: ["main"]
  workflow_dispatch:

env:
  REGISTRY: ghcr.io
  IMAGE_NAME: ${{ github.repository }}

jobs:
  build-and-push-image:
    runs-on: ubuntu-latest
    timeout-minutes: 30
    permissions:
      contents: read
      packages: write
      attestations: write
      id-token: write
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
      - name: Log in to the Container registry
        uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
        with:
          registry: ${{ env.REGISTRY }}
          username: ${{ github.actor }}
          password: ${{ secrets.GITHUB_TOKEN }}
      - name: Extract metadata (tags, labels) for Docker
        id: meta
        uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
        with:
          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v3

      - name: Build and push Docker image
        id: push
        timeout-minutes: 25
        uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
        with:
          context: .
          push: true
          tags: ${{ steps.meta.outputs.tags }}
          labels: ${{ steps.meta.outputs.labels }}
          cache-from: type=gha
          cache-to: type=gha,mode=max
          # ⚠️
          # It's recommended to only include environment variables needed for the build
          # Environment variables starting with NEXT_PUBLIC_ use vars
          # Other environment variables use secrets
          build-args: |
            NEXT_PUBLIC_SITE_URL=${{ vars.NEXT_PUBLIC_SITE_URL }}
            NEXT_PUBLIC_PRICING_PATH=${{ vars.NEXT_PUBLIC_PRICING_PATH }}
            NEXT_PUBLIC_OPTIMIZED_IMAGES=${{ vars.NEXT_PUBLIC_OPTIMIZED_IMAGES }}
            NEXT_PUBLIC_LOGIN_MODE=${{ vars.NEXT_PUBLIC_LOGIN_MODE }}
            NEXT_PUBLIC_GITHUB_CLIENT_ID=${{ vars.NEXT_PUBLIC_GITHUB_CLIENT_ID }}
            NEXT_PUBLIC_GOOGLE_CLIENT_ID=${{ vars.NEXT_PUBLIC_GOOGLE_CLIENT_ID }}
            NEXT_PUBLIC_TURNSTILE_SITE_KEY=${{ vars.NEXT_PUBLIC_TURNSTILE_SITE_KEY }}
            NEXT_PUBLIC_ENABLE_STRIPE=${{ vars.NEXT_PUBLIC_ENABLE_STRIPE }}
            NEXT_PUBLIC_DEFAULT_CURRENCY=${{ vars.NEXT_PUBLIC_DEFAULT_CURRENCY }}
            NEXT_PUBLIC_GOOGLE_ID=${{ vars.NEXT_PUBLIC_GOOGLE_ID }}
            NEXT_PUBLIC_PLAUSIBLE_DOMAIN=${{ vars.NEXT_PUBLIC_PLAUSIBLE_DOMAIN }}
            NEXT_PUBLIC_PLAUSIBLE_SRC=${{ vars.NEXT_PUBLIC_PLAUSIBLE_SRC }}
            NEXT_PUBLIC_DISCORD_INVITE_URL=${{ vars.NEXT_PUBLIC_DISCORD_INVITE_URL }}
            NEXT_PUBLIC_AUTO_FILL_AI_PROVIDER=${{ vars.NEXT_PUBLIC_AUTO_FILL_AI_PROVIDER }}
            NEXT_PUBLIC_AUTO_FILL_AI_MODEL_ID=${{ vars.NEXT_PUBLIC_AUTO_FILL_AI_MODEL_ID }}
            NEXT_PUBLIC_DAILY_AI_AUTO_FILL_LIMIT=${{ vars.NEXT_PUBLIC_DAILY_AI_AUTO_FILL_LIMIT }}
            NEXT_PUBLIC_DAILY_SUBMIT_LIMIT=${{ vars.NEXT_PUBLIC_DAILY_SUBMIT_LIMIT }}
            NEXT_PUBLIC_DAILY_IMAGE_UPLOAD_LIMIT=${{ vars.NEXT_PUBLIC_DAILY_IMAGE_UPLOAD_LIMIT }}
            R2_PUBLIC_URL=${{ secrets.R2_PUBLIC_URL }}
            R2_ACCOUNT_ID=${{ secrets.R2_ACCOUNT_ID }}
            R2_ACCESS_KEY_ID=${{ secrets.R2_ACCESS_KEY_ID }}
            R2_SECRET_ACCESS_KEY=${{ secrets.R2_SECRET_ACCESS_KEY }}
            R2_BUCKET_NAME=${{ secrets.R2_BUCKET_NAME }}
            DATABASE_URL=${{ secrets.DATABASE_URL }}
            BETTER_AUTH_SECRET=${{ secrets.BETTER_AUTH_SECRET }}
            BETTER_AUTH_GITHUB_CLIENT_SECRET=${{ secrets.BETTER_AUTH_GITHUB_CLIENT_SECRET }}
            GOOGLE_CLIENT_SECRET=${{ secrets.GOOGLE_CLIENT_SECRET }}
            STRIPE_SECRET_KEY=${{ secrets.STRIPE_SECRET_KEY }}
            STRIPE_PUBLISHABLE_KEY=${{ secrets.STRIPE_PUBLISHABLE_KEY }}
            STRIPE_WEBHOOK_SECRET=${{ secrets.STRIPE_WEBHOOK_SECRET }}
            STRIPE_CUSTOMER_PORTAL_URL=${{ secrets.STRIPE_CUSTOMER_PORTAL_URL }}

```

--------------------------------

### Manage and View Logs on VPS

Source: https://nexty.dev/docs/start-project/coolify

Commands to inspect, monitor, and export persistent log files generated by the Next.js application on the host machine.

```bash
# View log file list
ls -la /var/log/nexty-dev/
 
# View logs in real-time
tail -f /var/log/nexty-dev/xxxxxxxx-*.log
 
# Search for specific content
grep "error" /var/log/nexty-dev/xxxxxxxx-*.log

# Execute on your local machine to export logs
scp -r root@ip:/var/log/nexty-dev/ ./nexty-logs/
```

--------------------------------

### GET /api/payment/verify-success

Source: https://nexty.dev/docs/guide/payment/payment-flow

Verifies the status of a payment session initiated via Stripe or Creem and returns the order or subscription details.

```APIDOC
## GET /api/payment/verify-success

### Description
Validates payment session status with the respective provider (Stripe or Creem) and confirms the transaction for the authenticated user.

### Method
GET

### Endpoint
/api/payment/verify-success

### Parameters
#### Query Parameters
- **provider** (string) - Required - The payment provider (e.g., "stripe" or "creem").
- **session_id** (string) - Optional - Required if provider is "stripe".
- **checkout_id** (string) - Optional - Required if provider is "creem".

### Request Example
GET /api/payment/verify-success?provider=stripe&session_id=cs_test_123

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the verification was successful.
- **data** (object) - Contains order or subscription details.

#### Response Example
{
  "success": true,
  "data": {
    "order": {
      "id": "order-id",
      "status": "succeeded",
      "amountTotal": "29.00",
      "currency": "USD"
    }
  }
}
```

--------------------------------

### GET /payment/success

Source: https://nexty.dev/docs/guide/payment/payment-flow

Redirect endpoint after a user completes payment. It is used to display a success message and potentially trigger further actions.

```APIDOC
## GET /payment/success

### Description
This endpoint is a redirect URL used after a user successfully completes a payment. It receives session details and provider information to confirm the payment status.

### Method
GET

### Endpoint
/payment/success

### Parameters
#### Query Parameters
- **session_id** (string) - Optional - The ID of the Stripe checkout session.
- **provider** (string) - Required - The payment provider used (e.g., 'stripe', 'creem').

### Request Example
`/payment/success?session_id=cs_12345&provider=stripe`

### Response
#### Success Response (200)
Typically renders a success page or message to the user. Specific response details depend on the frontend implementation.

#### Response Example
(Frontend renders a success page)
```

--------------------------------

### Initialize and Connect Supabase Database

Source: https://nexty.dev/docs/integration/supabase

Commands to authenticate with Supabase, link the local project to a remote database, and run initial migrations.

```shell
pnpm db:login
pnpm db:link
pnpm db:update
```

--------------------------------

### Calculate Aggregate Statistics

Source: https://nexty.dev/docs/guide/auth-database/database

Uses SQL fragments to perform conditional counting, summation, and time-based grouping (truncation) on database records.

```typescript
import { sql, and, gte, lt } from 'drizzle-orm';
 
const start = new Date('2025-01-01');
const end = new Date('2025-02-01');
 
// Aggregation with FILTER
const stats = await db
  .select({
    oneTimeCount: sql`COUNT(*) FILTER (WHERE ${orders.orderType} = 'one_time_purchase')`.mapWith(Number),
    monthlyRevenue: sql`COALESCE(SUM(${orders.amountTotal}) FILTER (WHERE ${pricingPlans.recurringInterval} = 'month'), 0)`.mapWith(Number),
  })
  .from(orders)
  .leftJoin(pricingPlans, eq(orders.planId, pricingPlans.id))
  .where(and(gte(orders.createdAt, start), lt(orders.createdAt, end)));
 
// Daily aggregation (date_trunc)
const dt = sql`date_trunc('day', ${orders.createdAt})`;
const daily = await db
  .select({ date: dt, count: count(orders.id) })
  .from(orders)
  .where(and(gte(orders.createdAt, start), lt(orders.createdAt, end)))
  .groupBy(dt);
```

--------------------------------

### Perform Upsert Operations

Source: https://nexty.dev/docs/guide/auth-database/database

Implements idempotent writes using onConflictDoUpdate to handle synchronization scenarios like subscription updates or quota increments.

```typescript
// Subscription upsert
const { stripeSubscriptionId, ...updateData } = subscriptionData;
await db.insert(subscriptions)
  .values(subscriptionData)
  .onConflictDoUpdate({
    target: subscriptions.stripeSubscriptionId,
    set: updateData,
  });
 
// usage table upsert by userId (accumulate/overwrite)
await db.insert(usage)
  .values({ userId, oneTimeCreditsBalance: add })
  .onConflictDoUpdate({
    target: usage.userId,
    set: { oneTimeCreditsBalance: sql`${usage.oneTimeCreditsBalance} + ${add}` },
  });
```

--------------------------------

### Manage Yearly Subscription Credits

Source: https://nexty.dev/docs/guide/payment/credit-system

Handles credit allocation for yearly subscriptions using a monthly approach. It calculates the next credit date and initializes or updates the user's credit balance with yearly allocation details. This function also logs the initial credit grant for yearly plans.

```typescript
if (isYearlyInterval(plan.recurringInterval) && benefits?.totalMonths && benefits?.monthlyCredits) {
  await db.transaction(async (tx) => {
    const startDate = new Date(currentPeriodStart);
    const nextCreditDate = new Date(
      startDate.getFullYear(),
      startDate.getMonth() + 1,
      startDate.getDate()
    );
 
    const yearlyDetails = {
      yearlyAllocationDetails: {
        remainingMonths: benefits.totalMonths - 1,
        nextCreditDate: nextCreditDate.toISOString(),
        monthlyCredits: benefits.monthlyCredits,
        lastAllocatedMonth: `${startDate.getFullYear()}-${(startDate.getMonth() + 1).toString().padStart(2, '0')}`,
        relatedOrderId: orderId,
      }
    };
 
    // Initialize yearly subscription, immediately allocate first month's credits
    const updatedUsage = await tx
      .insert(usageSchema)
      .values({
        userId,
        subscriptionCreditsBalance: benefits.monthlyCredits,
        balanceJsonb: yearlyDetails,
      })
      .onConflictDoUpdate({
        target: usageSchema.userId,
        set: {
          subscriptionCreditsBalance: benefits.monthlyCredits,
          balanceJsonb: sql`coalesce(${usageSchema.balanceJsonb}, '{}'::jsonb) - 'yearlyAllocationDetails' || ${JSON.stringify(yearlyDetails)}::jsonb`,
        }
      })
      .returning({
        oneTimeBalanceAfter: usageSchema.oneTimeCreditsBalance,
        subscriptionBalanceAfter: usageSchema.subscriptionCreditsBalance,
      });
 
    // Record credit log
    await tx.insert(creditLogsSchema).values({
      userId,
      amount: benefits.monthlyCredits,
      oneTimeBalanceAfter: updatedUsage[0].oneTimeBalanceAfter,
      subscriptionBalanceAfter: updatedUsage[0].subscriptionBalanceAfter,
      type: 'subscription_grant',
      notes: 'Yearly plan initial credits granted',
      relatedOrderId: orderId,
    });
  });
}
```

--------------------------------

### Insert, Update, and Delete Records

Source: https://nexty.dev/docs/guide/auth-database/database

Standard CRUD operations including inserting data with returning clauses, updating specific fields, and deleting records by ID.

```typescript
import { InferInsertModel } from 'drizzle-orm';
 
type NewOrder = InferInsertModel<typeof orders>;
 
const orderData: NewOrder = {
  userId,
  provider: 'stripe',
  providerOrderId: 'pi_123',
  status: 'succeeded',
  orderType: 'one_time_purchase',
  amountTotal: '9.90',
  currency: 'usd',
};
 
const inserted = await db.insert(orders).values(orderData).returning({ id: orders.id });
const orderId = inserted[0]?.id;

// Update
await db.update(user)
  .set({ banned: true, banReason: 'By admin', banExpires: null })
  .where(eq(user.id, userId));

// Delete
await db.delete(orders).where(eq(orders.id, orderId));
```

--------------------------------

### Implement Page-level Auth Guards

Source: https://nexty.dev/docs/guide/auth-database/auth

Utilizes the AuthGuard component to restrict access to specific pages or layouts based on authentication status or user roles.

```typescript
import { AuthGuard } from "@/components/auth/AuthGuard";
 
export default async function LoginRequiredLayout() {
  return (
    <AuthGuard>
      {/* Content visible only to logged-in users */}
    </AuthGuard>
  );
}
```

```typescript
import { AuthGuard } from "@/components/auth/AuthGuard";
 
export default async function AdminLayout() {
  return (
    <AuthGuard role="admin">
      {/* Content visible only to admins */}
    </AuthGuard>
  );
}
```

--------------------------------

### Display Pricing Components

Source: https://nexty.dev/docs/guide/payment/prices-card

React components for rendering pricing tables. Pricing component supports categorization by payment type, while PricingAll displays all active plans.

```TypeScript
import Pricing from '@/components/home/Pricing';
import PricingAll from '@/components/home/PricingAll';

export default function PricingPage() {
  return <Pricing />;
}
```

--------------------------------

### Configure Theme Colors and Browser Icons

Source: https://nexty.dev/docs/guide/site-config

Sets the browser address bar colors based on system preferences and defines the paths for site favicons and shortcut icons.

```typescript
themeColors: [
  { media: '(prefers-color-scheme: light)', color: '#3b82f6' },
  { media: '(prefers-color-scheme: dark)', color: '#1e40af' },
]

icons: {
  icon: "/favicon.ico",
  shortcut: "/logo.png",
  apple: "/logo.png",
}
```

--------------------------------

### GET /api/payment/verify-success

Source: https://nexty.dev/docs/guide/payment/payment-flow

Verifies the payment status after a user is redirected back from the payment provider. It uses the session ID or other identifiers to confirm the transaction's success.

```APIDOC
## GET /api/payment/verify-success

### Description
Verifies the payment status after a user is redirected back from the payment provider. It uses the session ID or other identifiers to confirm the transaction's success and update the order status.

### Method
GET

### Endpoint
/api/payment/verify-success

### Parameters
#### Query Parameters
- **session_id** (string) - Required - The ID of the checkout session to verify.
- **provider** (string) - Required - The payment provider used (e.g., 'stripe', 'creem').

### Request Example
`/api/payment/verify-success?session_id=cs_12345&provider=stripe`

### Response
#### Success Response (200)
- **status** (string) - The status of the payment verification (e.g., 'success', 'pending', 'failed').
- **orderId** (string) - The ID of the created or updated order.

#### Response Example
```json
{
  "data": {
    "status": "success",
    "orderId": "ord_abcde"
  }
}
```
```

--------------------------------

### Manage Log Persistence on VPS

Source: https://nexty.dev/docs/integration/pino-and-sentry

Commands for managing log files and streaming output on VPS environments using PM2 or direct file system access.

```bash
tail -f /var/lib/coolify/myapp/logs/payment-service.2025-03-08.1.log
```

```bash
pm2 start npm --name "myapp" -- start
pm2 logs myapp
```

--------------------------------

### Configure Vercel Cron Jobs

Source: https://nexty.dev/docs/start-project/cron

Defines scheduled tasks in the vercel.json configuration file. Each object requires a path to the API endpoint and a standard cron expression for the schedule.

```json
{
  "crons": [
    {
      "path": "/api/cron/task1",
      "schedule": "0 0 * * *"
    },
    {
      "path": "/api/cron/task2",
      "schedule": "0 2 * * 1"
    }
  ]
}
```

--------------------------------

### Configure GitHub OAuth App

Source: https://nexty.dev/docs/integration/supabase

Steps to set up a GitHub OAuth application, including filling in Homepage URL and Authorization callback URL. This process generates a Client ID and Client Secret required for Supabase authentication.

--------------------------------

### Extend database schema for new content types

Source: https://nexty.dev/docs/guide/cms

Demonstrates how to add a new content type to the PostgreSQL enum and execute migration commands.

```typescript
export const postTypeEnum = pgEnum('post_type', [
  'blog',
  'glossary',
  'guide',
])
```

```bash
pnpm db:generate
pnpm db:migrate
```

--------------------------------

### Environment Variables for API Keys

Source: https://nexty.dev/docs/integration/supabase

Example of how to set environment variables for Supabase and Google authentication. These variables are crucial for connecting to Supabase services and enabling Google One Tap functionality.

```dotenv
# .env.local or .env

NEXT_PUBLIC_SUPABASE_URL=""
NEXT_PUBLIC_SUPABASE_ANON_KEY=""
SUPABASE_SERVICE_ROLE_KEY=""
NEXT_PUBLIC_GOOGLE_CLIENT_ID=""
```

--------------------------------

### Login to GitHub CLI

Source: https://nexty.dev/docs/start-project/sync-env-to-github

Authenticates the GitHub CLI with your GitHub account. This command initiates an interactive process to log you in, which is necessary for performing actions like syncing environment variables.

```bash
gh auth login
```
Tokens:
Raw