Help Center

Quick Start

Get your application running in minutes with this quick start guide.

Note: This is mock/placeholder content for demonstration purposes.

Get your development environment up and running quickly.

Prerequisites

Before you begin, ensure you have:

  • Node.js 18.x or higher
  • pnpm 8.x or higher
  • Git for version control
  • A PostgreSQL database (local or hosted)

Step 1: Clone the Repository

git clone https://github.com/yourorg/yourapp.git
cd yourapp

Step 2: Install Dependencies

pnpm install

This will install all required dependencies across the monorepo.

Step 3: Set Up Environment Variables

Copy the example environment file:

cp apps/web/.env.example apps/web/.env.local

Update the following variables:

# Database Configuration
DATABASE_URL=postgresql://user:password@localhost:5432/dbname

# Application
NEXT_PUBLIC_SITE_URL=http://localhost:3000

Step 4: Start Database

Start your local database:

pnpm dev:compose:up

This will:

  • Start PostgreSQL database
  • Apply all migrations
  • Seed initial data

Step 5: Start Development Server

pnpm dev

Your application will be available at:

  • App: http://localhost:3000
  • Email Testing: http://localhost:54324

Step 6: Create Your First User

  1. Navigate to http://localhost:3000/auth/sign-up
  2. Enter your email and password
  3. Check http://localhost:54324 for the confirmation email
  4. Click the confirmation link
  5. You're ready to go!

Next Steps

Now that your app is running:

  1. Explore the Dashboard - Check out the main features
  2. Review the Code - Familiarize yourself with the structure
  3. Read the Docs - Learn about key concepts
  4. Build Your Feature - Start customizing

Common Issues

Port Already in Use

If port 3000 is already in use:

# Find and kill the process
lsof -i :3000
kill -9 <PID>

Database Won't Start

Try resetting the database:

pnpm dev:compose:down
docker system prune -a  # Clean Docker
pnpm dev:compose:up

Database Connection Error

Ensure Docker is running and restart the database:

docker ps  # Check Docker is running
pnpm dev:compose:down
pnpm dev:compose:up

What's Next?