Welcome to FlareStack
Here's a quick rundown of the boilerplate. Follow these steps to get your app going.
Clone the repo
bashgit clone 'https://github.com/Larry-Osakwe/FlareStack.git' [YOUR_APP_NAME]
Starting the local server
Navigate to your newly created app
bashcd [YOUR_APP_NAME]
Install the dependencies
bashnpm install
Remove the origin
bashgit remote remove origin
Rename the environment variable file
.env.example
bashmv .env.example .env.local
Start the server
bashnpm run dev
Connecting to Supabase
Go to your Supabase dashboard, create a new project and paste your three Supabase environment variables in .env.local
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
/app | Create pages for your authenticated and unauthenticated routes |
/app/api | Make your api calls here |
/components | Various react components for your own customization |
/components/ui | Shadcn UI components |
/libs | Helper functions for the various services (Stripe, Resend, Supabase, etc) |
/types | Define 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.