Getting Started

Get up and running with our platform in minutes.

Getting Started

Welcome! This guide will help you set up your project from scratch.

Note

This guide assumes you have basic familiarity with TypeScript and React.

Prerequisites

Before you begin, make sure you have:

  • Bun v1.0 or later
  • A Neon PostgreSQL database (free tier works)
  • Node.js 18+ (for compatibility)

Installation

Clone the repository and install dependencies:

git clone https://github.com/your-org/your-repo.git
cd your-repo
bun install

Environment Setup

Copy the example environment file:

cp .env.example .env

Important

Never commit your .env file to version control. It contains secrets.

Then fill in the required values:

DATABASE_URL=postgresql://...
BETTER_AUTH_SECRET=your-secret-here
BETTER_AUTH_URL=http://localhost:3000

Database Setup

Initialize the database schema:

bun run scripts/init-db.ts

Start Development

Run the development server:

bun run dev

Your app is now running at http://localhost:3000.

Project Structure

Here's a quick overview of the key directories:

Directory Purpose
app/routes/ Page and API routes
components/ Reusable UI components
lib/ Utilities, auth, database
database/ Schema and migrations
public/ Static assets

Next Steps