NextFaster Documentation

The data/data.zip file contains a data.sql file with the full schema and over 1,000,000 products. Because this data exceeds the free tier limits for Neon on Vercel, you must seed it manually using psql:

1. Unzip data.zip to obtain data.sql.
2. Run the following command using your connection string:

psql "YOUR_CONNECTION_STRING" -f data/data.sql

To deploy NextFaster, ensure your Vercel project is connected to both Vercel Postgres (Neon) and Vercel Blob Storage. After deployment, apply the database schema by running:

pnpm db:push

Follow these steps to configure your local environment:

1. Link to Vercel: Run vc link to connect your local project to your Vercel account.
2. Pull Environment Variables: Run vc env pull to generate a .env.local file containing your database credentials.
3. Install Dependencies: Run pnpm install.
4. Start Development Server: Run pnpm dev.

Note for DB Migrations: When using drizzle-kit, ensure ?sslmode=required is appended to your POSTGRES_URL environment variable.

NextFaster requires specific roles to be created in your database. Connect to your database using psql and execute the following commands:

CREATE ROLE default;
CREATE ROLE cloud_admin;

The project uses drizzle-kit for database migrations and schema management. The configuration requires a PostgreSQL dialect and points to the schema definition located at ./src/db/schema.ts. Database connection details are provided via the POSTGRES_URL environment variable.

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  schema: "./src/db/schema.ts",
  dialect: "postgresql",
  dbCredentials: {
    url: process.env.POSTGRES_URL!,
  },
  verbose: true,
  strict: true,
});

Use these functions to retrieve the number of products in specific scopes:

• getProductCount(): Returns the total count of all products in the database.
• getCategoryProductCount(categorySlug): Returns the count of products within a specific category (including nested subcollections/subcategories).
• getSubcategoryProductCount(subcategorySlug): Returns the count of products within a specific subcategory.

All count queries are cached for 2 hours.

The session utility provides functions to manually sign and verify JSON Web Tokens (JWT) using the AUTH_SECRET environment variable. Tokens are signed using the HS256 algorithm and are set to expire 1 day after issuance.

signToken accepts a SessionData object:

• user: An object containing the user { id: number }.
• expires: An ISO string representing the expiration time.

verifyToken returns the decoded SessionData payload.

The session utility provides high-level helpers to manage authentication state using Next.js cookies.

• setSession(user: NewUser): Creates a session token containing the user's ID, signs it, and stores it in a cookie named session. The cookie is configured as httpOnly, secure, and sameSite: 'lax', with a 24-hour expiration.
• getSession(): Retrieves the session cookie from the request headers and verifies it. Returns the SessionData payload if valid, or null if the cookie is missing or invalid.

The database schema is defined using drizzle-orm for PostgreSQL. It includes tables for organizing products through a hierarchical structure: collections -> categories -> subcollections -> subcategories -> products. Additionally, a users table is provided for authentication.

Key entities and their TypeScript types include:

• Collection: Represents top-level groups.
• Category: Belongs to a Collection via collection_id.
• Subcollection: Belongs to a Category via category_slug.
• Subcategory: Belongs to a Subcollection via subcollection_id.
• Product: Belongs to a Subcategory via subcategory_slug. Includes full-text search and trigram indexes on the name field.
• User: Contains username, passwordHash, and timestamps.