Skip to main content

Requirements & Installation

Running from source gives you seeded test data and hot reload — better for evaluating the project or developing against it. For a production deployment, see Production Deployment; for the fastest way to try it with zero local toolchain setup, see the Docker quickstart.

Requirements​

  • Node.js 24+
  • PostgreSQL 14+
  • Redis 6+ (optional — only needed for async webhook processing or auth rate limiting; see Configuration)

Install​

git clone https://github.com/roshansingh/programmableinbox.git
cd programmableinbox
npm install
cp .env.example .env

Fill in .env — see Configuration for what's required.

npx prisma migrate dev
npx prisma generate  # regenerates lib/generated/prisma; migrate dev does not do this on its own
npx prisma db seed   # creates [email protected] / password123
npm run dev

The app is now running at http://localhost:4000. Log in with [email protected] / password123, or register a new account.