Quick Start

Clone ngXpress and have it running locally in a few minutes.

This gets ngXpress running on your machine against a local PostgreSQL database.

Prerequisites

  • Node.js 20+
  • pnpm 11 (the repo pins its package manager; the lockfile is the source of truth)
  • A database — PostgreSQL by default, database name ngxpress

1. Get the code

Use this template on GitHub or clone it directly:

Terminal
git clone https://github.com/angularcafe/ngXpress.git
cd ngXpress

2. Install dependencies

Terminal
pnpm install

3. Configure the environment

Terminal
cp .env.example .env

Generate a secret for Better Auth:

Terminal
openssl rand -base64 32

Paste it into BETTER_AUTH_SECRET. Keep BETTER_AUTH_TRUSTED_ORIGINS in sync with the URLs you actually use — http://localhost:4200 for pnpm dev, http://localhost:4000 for a local production build. See Environment Variables for the full reference.

4. Set up the database

Create an empty PostgreSQL database (default name ngxpress), then:

Terminal
pnpm db:generate
pnpm db:deploy

db:deploy applies the committed migrations (prisma migrate deploy). Use db:migrate instead when you're changing the schema locally — see Database & Prisma.

5. Run it

Terminal
pnpm dev

Open http://localhost:4200. Angular SSR and the Express API are both served from that one process.

Rebrand the demo product in src/app/core/config/app-brand.ts (APP_NAME, tagline, template URL) and the <title> in src/index.html.

Next steps

PreviousIntroductionNextProject Structure