Welcome to FlareStack

Here's a quick rundown of the boilerplate. Follow these steps to get your app going.

Clone the repo

bash
git clone 'https://github.com/Larry-Osakwe/FlareStack.git' [YOUR_APP_NAME]

Starting the local server

  1. Navigate to your newly created app

    bash
    cd [YOUR_APP_NAME]
  2. Install the dependencies

    bash
    npm install
  3. Remove the origin

    bash
    git remote remove origin
  4. Rename the environment variable file .env.example

    bash
    mv .env.example .env.local
  5. Start the server

    bash
    npm run dev

Connecting to Supabase

Go to your Supabase dashboard, create a new project and paste your three Supabase environment variables in .env.local

NEXT_PUBLIC_SUPABASE_URL
NEXT_PUBLIC_SUPABASE_ANON_KEY
SUPABASE_SERVICE_ROLE_KEY

View your application

In your browser, open http://localhost:3000 to see your site

Project Structure

FlareStack is a NextJS app router application, which means it contains a file structure to facilitate most parts of the stack

/appCreate pages for your authenticated and unauthenticated routes
/app/apiMake your api calls here
/componentsVarious react components for your own customization
/components/uiShadcn UI components
/libsHelper functions for the various services (Stripe, Resend, Supabase, etc)
/typesDefine any types needed

App Configuration

In the root of the project you will find a config.ts file. This gives you app level configuration that will affect most of your application.

Environment Variable file

The .env.example that you renamed to .env.local will house the environment variables needed to operate the application.