Quick Start Guide

Get your platform up and running in 15 minutes. Follow these steps to clone, configure, and deploy.

Step 1

Clone the Repository

Get the platform code on your local machine

# Clone your platform repository

git clone https://github.com/your-org/your-platform.git

cd your-platform

# Install dependencies

npm install

This will download all platform files and install required packages

Step 2

Configure Environment

Set up your environment variables

# Copy the example environment file

cp .env.example .env.local

# Edit .env.local with your values

# DATABASE_URL=your_database_url

# NEXTAUTH_SECRET=your_secret

# NEXTAUTH_URL=http://localhost:3000

Database connection string from Neon.tech or your provider

Generate secret with: openssl rand -base64 32

Step 3

Setup Database

Initialize your PostgreSQL database

# Push database schema

npm run db:push

# Optional: Seed with sample data

npm run db:seed

Creates all tables and relationships in your database

Step 4

Run Development Server

Start building and testing locally

# Start the development server

npm run dev

# Server running at http://localhost:3000

Open http://localhost:3000 in your browser to see your platform

Next Steps

Continue building your platform