Get Started

Hey maker, welcome to NativeFast! 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!

1. $ git clone https://github.com/Marc-Louvion/ship-fast.git [YOUR_APP_NAME]
2. $ cd [YOUR_APP_NAME]
3. $ git remote remove origin
4. $ npm run dev

NativeFast requires Node 18 or greater. Type node -v in your terminal to check version.

$ mv .env.example .env.local

Open http://localhost:3000 to see your site. And voilà!

You will see errors in the console but nothing important.

NextJS project structure

• /app – Pages (folder pages), 1 page=1 page
• /api – API calls (1 file = 1 API endpoint)
• /components – React components
• /lib – Libraries (helper functions)
• /models – Database models

config.js file

This 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:

NEXTAUTH_URL=http://localhost:3000
NEXTAUTH_SECRET=your-secret-key
GOOGLE_ID=your-google-id
GOOGLE_SECRET=your-google-secret
MAILGUN_API_KEY=your-mailgun-api-key
PRISMA_URL=your-prisma-url
STRIPE_PUBLIC_KEY=your-stripe-public-key
STRIPE_SECRET_KEY=your-stripe-secret-key