FireGEO Documentation

The fastest way to get the FireGEO SaaS starter running is using the automated setup script. This script installs dependencies, tests the database connection, generates Better Auth tables, applies migrations, and configures Autumn billing if an API key is provided.

Prerequisites

• Node.js 18+ and npm
• PostgreSQL database

Setup Steps

1. Clone the repository and enter the directory:

   git clone https://github.com/mendableai/firegeo
   cd firegeo

2. Copy the environment variables template:

   cp .env.example .env.local

3. Add required keys to .env.local:
   • DATABASE_URL: Your PostgreSQL connection string.
   • BETTER_AUTH_SECRET: A secure secret generated via openssl rand -base64 32.
4. Run the automated setup:

   npm run setup

5. Start the development server:

   npm run dev

Visit http://localhost:3000 to view your application.

# Clone the repository
git clone https://github.com/mendableai/firegeo
cd firegeo

# Copy environment variables
cp .env.example .env.local

# Run the automated setup
npm run setup

# Start Development
npm run dev

If you need granular control, follow these steps to manually configure the project:

1. Install Dependencies

npm install

2. Environment Variables

Copy the example file and edit it:

cp .env.example .env.local
nano .env.local

Generate a secure secret for BETTER_AUTH_SECRET using:

openssl rand -base64 32

3. Database Initialization

Push the schema, generate Better Auth tables, and apply migrations:

npm run db:push
npx @better-auth/cli generate --config better-auth.config.ts
npm run db:push

4. Configure Autumn Billing

Run the specific Autumn setup script:

npm run setup:autumn

5. Verify Setup

Check the database via Drizzle Studio and start the server:

npm run db:studio
npm run dev

# Manual Setup Sequence
npm install
cp .env.example .env.local
# (Edit .env.local with DATABASE_URL and BETTER_AUTH_SECRET)
npm run db:push
npx @better-auth/cli generate --config better-auth.config.ts
npm run db:push
npm run setup:autumn
npm run dev

The brand detection system can be configured globally using updateBrandDetectionConfig. This allows you to modify detection options, brand aliases, ignored suffixes, negative context patterns, and confidence thresholds.

Configuration Schema (BrandDetectionConfig)

• defaultOptions: BrandDetectionOptions object (e.g., caseSensitive, wholeWordOnly, includeVariations, excludeNegativeContext).
• brandAliases: A Map<string, string[]> mapping brand names to their known variations.
• ignoredSuffixes: An array of strings (e.g., ['inc', 'llc']) to ignore when matching brands.
• negativeContextPatterns: An array of RegExp used to exclude matches found in negative contexts (e.g., patterns matching "avoid using" or "scam").
• confidenceThresholds: An object containing high, medium, and low numeric thresholds (default values: high: 0.8, medium: 0.5, low: 0.3).

import { updateBrandDetectionConfig } from './lib/brand-detection-config';

updateBrandDetectionConfig({
  confidenceThresholds: {
    high: 0.9,
    medium: 0.6,
    low: 0.4
  },
  ignoredSuffixes: ['corp', 'ltd']
});

The project uses drizzle-kit for database migrations. The configuration is defined in drizzle.config.ts and uses a PostgreSQL dialect. It specifically excludes tables managed by Better Auth from the migration process using the tablesFilter option to prevent conflicts.

Key configuration settings:

• schema: Points to the source of truth for the database schema at ./lib/db/schema.ts.
• out: The directory where generated migrations are stored (./drizzle-generated).
• dialect: Set to postgresql.
• dbCredentials: Requires a url provided via the DATABASE_URL environment variable.
• tablesFilter: Uses negation patterns to exclude Better Auth tables (!user, !session, !account, !verification) from being managed by Drizzle migrations.

import type { Config } from 'drizzle-kit';
import * as dotenv from 'dotenv';

// Load environment variables
dotenv.config({ path: '.env.local' });

export default {
  schema: './lib/db/schema.ts',
  out: './drizzle-generated',
  dialect: 'postgresql',
  dbCredentials: {
    url: process.env.DATABASE_URL!,
  },
  // Exclude Better Auth tables from migrations since they're managed by Better Auth
  tablesFilter: ['!user', '!session', '!account', '!verification'],
} satisfies Config;