Documentación

Installation

Getting StartedLocal setupReady in minutes

Get the project running locally by installing dependencies, configuring your environment, and preparing the database.

This is the fastest path to a working development environment before you start customizing branding, integrations, or product behavior.

Before you begin

Make sure you already have access to a PostgreSQL database and a package manager compatible with the project scripts, such as pnpm.

Requirements

Use the checklist below before starting the local setup flow.

What you need

  • Node.js 18.17 or newer
  • A PostgreSQL database
  • A package manager compatible with the repo scripts, such as pnpm
Setup flow

Installation steps

Follow this sequence to get the app running correctly on your machine.

1

Install dependencies

Clone the repository, enter the project folder, and install the packages required to run the app.

2

Configure environment variables

Copy the environment template and provide the values needed for auth, email, payments, and app defaults.

3

Prepare the database

Push the Prisma schema to your local or remote PostgreSQL database so the app has the required tables.

4

Start the app

Launch the development server and confirm the project boots successfully in the browser.

Step 1: Install dependencies

Start by cloning the project and installing dependencies locally.

Install the projectbash
git clone <your-repo>
cd fast-unicorn
pnpm install

Step 2: Configure environment variables

Copy .env.example to .env and fill in the required values before trying to boot the app.

Environment reference

See Environment for the full variable list and service-specific setup notes.

Step 3: Prepare the database

Once your environment is configured, push the schema so the database is ready for local development.

Prepare the databasebash
pnpm db:push

Use pnpm db:generate if you want to work through Prisma migrations in development.

Step 4: Start the app

Boot the local development server and verify the app loads correctly.

Run the appbash
pnpm dev

Then open http://localhost:3000.

First review pass

What to change first

After the app boots locally, review these files before moving into deeper feature work.

  • src/config/site.ts: Update the product name, description, and brand metadata.
  • content/landing/en.json: Update the marketing content for the English locale.
  • content/landing/es.json: Update the marketing content for the Spanish locale.
  • content/landing/cn.json: Update the marketing content for the Chinese locale.
  • messages/en/*.json: Update the localized UI labels for the English locale.
  • messages/es/*.json: Update the localized UI labels for the Spanish locale.
  • messages/cn/*.json: Update the localized UI labels for the Chinese locale.

Recommended approach

Get the app running first, then move into configuration, copy, and localization updates before editing route components directly.