Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.tariqdev.xyz/llms.txt

Use this file to discover all available pages before exploring further.

​
Get Started

This guide gets Sonata running locally.
Sonata is a Next.js storefront. Most setup work is changing config, product data, assets, and environment variables, then checking that every public page still builds cleanly.

​
Requirements

Install:
  • Node.js 20 or newer.
  • pnpm 9 or newer.
  • Git.
  • A code editor.
Optional services:
  • Pterodactyl panel for live stock.
  • UptimeRobot for status monitoring.
  • Billing panel such as WHMCS, Paymenter, Blesta, or custom billing.

​
Install Dependencies

From the project root: 
pnpm install

​
Run Development Server

pnpm dev
Open: 
http://localhost:3000
If port 3000 is busy: 
pnpm dev -- -p 3001

​
Build Production

pnpm build
Start the production build: 
pnpm start

​
Environment Variables

Create .env.local in the project root. Example: 
PTERODACTYL_PANEL_URL=https://panel.example.com
PTERODACTYL_APP_KEY=ptla_xxxxxxxxxxxxxxxxx
UPTIMEROBOT_API_KEY=ur_xxxxxxxxxxxxxxxxx
NEXT_PUBLIC_DISCORD_GUILD_ID=000000000000000000
Restart the dev server after changing environment variables.

​
First Setup Checklist

  1. Update lib/config/site.ts.
  2. Replace logos and metadata assets.
  3. Update billing URLs.
  4. Update game hosting plans.
  5. Update web, app, VPS, domain, and node product data.
  6. Test light and dark mode.
  7. Test all product pages.
  8. Run a production build before deployment.
Use this order for a fresh installation:
  1. Install dependencies with pnpm install.
  2. Start local development with pnpm dev.
  3. Update brand details in lib/config/site.ts.
  4. Replace logos, favicon, and metadata images.
  5. Update product plans and checkout URLs.
  6. Connect optional integrations.
  7. Test every route on desktop and mobile.
  8. Run pnpm build.

​
Brand Setup

Open: 
lib/config/site.ts
Update these first:
FieldPurpose
nameShort brand name.
fullNameFull public brand name.
descriptionMain website description.
urlProduction website URL.
billing.urlBilling or checkout base URL.
billing.panelCustomer panel URL.
socialDiscord, email, marketplace, or community links.

​
Pages to Check

Before deployment, open: 
/
/game-host
/web-host
/app-host
/vps
/domain
/nodes
/status
/support
If a page crashes after editing product data, compare the new item with an existing working item in the same file.

​
Where to Go Next

General Configuration

Learn the main files for brand, navigation, data, and layout.

Product Data

Update plans, prices, tiers, specs, and checkout links.

Integrations

Connect Pterodactyl, UptimeRobot, Discord, billing, and domains.

Deployment

Prepare Sonata for Vercel, Railway, Render, or a VPS.