Getting Started

This guide will walk you through setting up your development environment and understanding the project structure.

Prerequisites

Make sure you have these installed before starting

Node.js (v18+)

Download from nodejs.org

node --version

pnpm

Package manager

pnpm --version

Installation

Set up your project locally

1. Clone or download the project

git clone https://github.com/aspagon17/buildfast-boilerplate.git

2. Install dependencies

cd buildfast-boilerplate
pnpm install

3. Start the development server

pnpm run dev

Your app will be running at http://localhost:3000

Project Structure

Understanding how the project is organized
app/ - Root application folder
api/ - API routes
dashboard/ - Example dashboard route you could protect with Auth0
success/ - Stripe success page (you can customize this)
components/ - Reusable UI components
emails/ - Reusable email templates
hooks/ - Hooks for the project
lib/ - Library components and setting up DB, Email, Stripe, Auth0, etc.
public/ - Static files including images and robots.txt
.env.example - Example environment variables for you to fill in

Environment Variables

You'll need to set these up for full functionality
NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY - Your Stripe publishable key
AUTH0_DOMAIN - Your Auth0 domain
AUTH0_CLIENT_ID - Your Auth0 client ID
AUTH0_SECRET - Your Auth0 secret
POSTGRES_URL - Your Postgres URL