Documentation

Get Started

Everything you need to download, configure, and start building with this production-ready Next.js boilerplate.

Download the Boilerplate

Choose your preferred method to get the code.

Clone via HTTPS

Best for most users. Requires Git installed.

bash

git clone https://github.com/poran120/react-nextjs-boilerplate.git

Clone via SSH

For users with SSH keys configured on GitHub.

bash

git clone git@github.com:poran120/react-nextjs-boilerplate.git

Download ZIP

No Git required. Downloads a compressed archive.

Download

Installation

Step-by-step guide to get the project running locally.

Navigate to the project

bash

cd react-nextjs-boilerplate

Install dependencies

Choose your preferred package manager:

npm

npm install

yarn

yarn install

pnpm

pnpm install

Start the development server

bash

npm run dev

The app will be available at http://localhost:3000

Environment Setup

Configure environment variables for your project.

Create a .env.local file in the project root:

.env.local

# Backend API
NEXT_PUBLIC_API_BASE_URL=http://localhost:8000

# Client URL
NEXT_PUBLIC_CLIENT_BASE_URL=http://localhost:3000

Environment Variables

NEXT_PUBLIC_API_BASE_URLRequiredBackend API base URL used by server actions

NEXT_PUBLIC_CLIENT_BASE_URLRequiredClient-facing base URL for redirects and links

NODE_ENVOptionalAutomatically set by Next.js (development / production)

Available Scripts

Built-in scripts for development, building, and linting.

npm run devStart development server with Turbopack

npm run buildCreate an optimized production build

npm run startStart the production server

npm run lintRun ESLint to check for code issues

Deployment

Deploy your application to production.

Vercel (Recommended)

Zero-config deployment optimized for Next.js.

Push your code to GitHub
Import the repository on vercel.com
Vercel auto-detects Next.js and configures the build
Set environment variables in the Vercel dashboard
Deploy

Manual Deployment

For custom hosting providers or self-hosted servers.

bash

npm run build
npm run start

Next Steps

Now that your project is running, explore the architecture to understand the folder structure, utilities, and conventions.

Explore Architecture →

Documentation

Get Started

Everything you need to download, configure, and start building with this production-ready Next.js boilerplate.

Download the Boilerplate

Choose your preferred method to get the code.

Clone via HTTPS

Best for most users. Requires Git installed.

bash

git clone https://github.com/poran120/react-nextjs-boilerplate.git

Clone via SSH

For users with SSH keys configured on GitHub.

bash

git clone git@github.com:poran120/react-nextjs-boilerplate.git

Download ZIP

No Git required. Downloads a compressed archive.

Download

Installation

Step-by-step guide to get the project running locally.

Navigate to the project

bash

cd react-nextjs-boilerplate

Install dependencies

Choose your preferred package manager:

npm

npm install

yarn

yarn install

pnpm

pnpm install

Start the development server

bash

npm run dev

The app will be available at http://localhost:3000

Environment Setup

Configure environment variables for your project.

Create a .env.local file in the project root:

.env.local

# Backend API
NEXT_PUBLIC_API_BASE_URL=http://localhost:8000

# Client URL
NEXT_PUBLIC_CLIENT_BASE_URL=http://localhost:3000

Environment Variables

NEXT_PUBLIC_API_BASE_URLRequiredBackend API base URL used by server actions

NEXT_PUBLIC_CLIENT_BASE_URLRequiredClient-facing base URL for redirects and links

NODE_ENVOptionalAutomatically set by Next.js (development / production)

Available Scripts

Built-in scripts for development, building, and linting.

npm run devStart development server with Turbopack

npm run buildCreate an optimized production build

npm run startStart the production server

npm run lintRun ESLint to check for code issues

Deployment

Deploy your application to production.

Vercel (Recommended)

Zero-config deployment optimized for Next.js.

Push your code to GitHub
Import the repository on vercel.com
Vercel auto-detects Next.js and configures the build
Set environment variables in the Vercel dashboard
Deploy

Manual Deployment

For custom hosting providers or self-hosted servers.

bash

npm run build
npm run start

Next Steps

Now that your project is running, explore the architecture to understand the folder structure, utilities, and conventions.

Explore Architecture →