Skip to main content
Use this page to choose the first setup path. Both distributions share the same Instagram and Google setup concepts, but they host callbacks and backend state differently.

​
Pick your path

Self-host Nudgra OSS

Run TanStack Start, Better Auth, Hono, Drizzle, pg-boss, and Postgres. Use this when you want to own the app server and database.

Run Nudgra Cloud

Run the Next.js dashboard with Convex Cloud. Use this when you want Convex to own backend state, auth, scheduling, and webhook functions.

​
Local prerequisites

Install these before either local setup path:
  • Git.
  • Node.js 24 or newer.
  • A Google account for sign-in.
  • A Meta Developer account.
  • An Instagram professional account.
Nudgra OSS also needs Docker or another Postgres database. Nudgra Cloud also needs a Convex account.

​
Fast local setup

1

Clone and install

git clone https://github.com/MaikoCode/nudgra-oss nudgra-oss
cd nudgra-oss
npm install
cp .env.example .env
In Windows PowerShell:
git clone https://github.com/MaikoCode/nudgra-oss nudgra-oss
cd nudgra-oss
npm install
Copy-Item .env.example .env
2

Start Postgres

docker run --name nudgra-postgres \
  -e POSTGRES_DB=nudgra \
  -e POSTGRES_USER=nudgra \
  -e POSTGRES_PASSWORD=nudgra \
  -p 5432:5432 \
  -d postgres:17-alpine
3

Configure the local environment

Set the local app URLs, generated secrets, and your operator email in .env.
SITE_URL=http://localhost:3000
BETTER_AUTH_URL=http://localhost:3000
TRUSTED_ORIGINS=http://localhost:3000,http://127.0.0.1:3000
BETTER_AUTH_SECRET=your-generated-secret
TOKEN_ENCRYPTION_KEY=your-generated-token-secret
OPERATOR_EMAIL_ALLOWLIST=your-google-email@gmail.com
4

Run the app

npm run db:migrate
npm run dev
Open http://localhost:3000.

​
Next steps