Setup Guide

Get your project up and running in just a few simple steps.

Project Setup

Clone the repository, navigate to the folder, and run npm install.

Database Setup

Default database is PostgreSQL. Find the database schema in the scripts/ folder and run them in order (schema-1.sql, schema-2.sql, ...) to set up your database.

Environment Variable Setup

Create a .env file in the root directory with the following variables.

DATABASE_URL=postgres://username:password@localhost:5432/your_database
JWT_SECRET=your-jwt-secret-key-here
ZEPTOMAIL_API_KEY=your-zeptomail-api-key
ZEPTOMAIL_FROM_ADDRESS=noreply@yourdomain.com
STRIPE_SECRET_KEY=sk_live_your-stripe-secret-key

Next Steps

Once you've completed the setup, you're ready to dive in! Here's what to do next:

  • Run npm run dev to start the development server
  • Navigate to http://localhost:3000 in your browser