Get Started
Hey maker, welcome to FastSaas 👋
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
💡
You’re browsing the /app router documentation. To use the /pages router, see here
Start a local server
- In your terminal, run the following commands one-by-one:
terminal
git clone https://github.com/GetFastSaas/next-starter-ts.git [YOUR_APP_NAME]
cd [YOUR_APP_NAME]
npm install
git remote remove origin
npm run dev
💡
FastSaas requires Node 18.17 or greater. Type node -v
in your terminal to
check version.
- Rename
.env.example
to.env.local
terminal
Terminal
mv.env.example.env.local;
- Open http://localhost:3000 to see your site. And voila!
💡
You will see errors in the console but nothing important.
NextJS project structure
- /app → Pages (1 folder + page.js = 1 page)
- /app/api → API calls (1 file = 1 API endpoint)
- /components → React components
- /libs → Libraries helper functions (Stripe & Mailgun, auth etc.)
- /models → Database models
config.js 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
. Change NEXTAUTH_SECRET
to anything else. The file content should look like this:
.env.local
NEXTAUTH_URL=http://localhost:3000
NEXTAUTH_SECRET=uhf3874y7fh387u87653947u4rh9394hf
GOOGLE_ID=
GOOGLE_SECRET=
MONGODB_URI=
EMAIL_SERVER=
MAILGUN_API_KEY=
STRIPE_PUBLIC_KEY=
STRIPE_SECRET_KEY=
STRIPE_WEBHOOK_SECRET=
Now go ahead and follow this tutorial to get your startup live within 5 minutes!