Get started

Here's a quick overview of the boilerplate. Follow along to get your app up and running.

Once you're done, start with this tutorial to launch your project in 5 minutes. Let's build that startup, FAST ⚡️

Start a local server

1. In your terminal, run the following commands one-by-one:

git clone https://github.com/gorillah/buildbox.git [YOUR_APP_NAME]
cd [YOUR_APP_NAME]
pnpm install
git remote remove origin
pnpm run dev

2. Rename .env.example to .env.local

mv .env.example .env.local

3. Go to the Supabase dashboard, create a new project and paste your 2 Supabase environment variables NEXT_PUBLIC_SUPABASE_URL & NEXT_PUBLIC_SUPABASE_ANON_KEY in .env.local

4. Open http://localhost:3000 to see your site. And voila!

NextJS project structure

config.ts file

It is where you configure your app. Each key is documented to know how and why it's used. Have a thorough look at it, it is the backbone of the app.

.env file

Rename the .env.example file to .env.local, The file content should look like this:

NEXT_PUBLIC_SITE_URL=http://localhost:3000
NEXT_PUBLIC_SUPABASE_URL=
NEXT_PUBLIC_SUPABASE_ANON_KEY=
SUPABSAE_PASSWORD=
RESEND_API_KEY=
EMAIL_FROM=
STRIPE_API_KEY=
STRIPE_SECRET_KEY=
STRIPE_WEBHOOK_SECRET=
NEXT_PUBLIC_STRIPE_PRO_MONTHLY_PLAN_ID=
NEXT_PUBLIC_STRIPE_PRO_YEARLY_PLAN_ID=
NEXT_PUBLIC_STRIPE_BUSINESS_MONTHLY_PLAN_ID=
NEXT_PUBLIC_STRIPE_BUSINESS_YEARLY_PLAN_ID=
LEMONSQUEEZY_API_KEY=
LEMON_SQUEEZY_VARIANT_ID=
LEMONSQUEEZY_STORE_ID=
LEMONSQUEEZY_WEBHOOK_SECRET=
GITHUB_ACCESS_TOKEN=    
GITHUB_OWNER=
GITHUB_REPOS=