Skip to main content

Next.js Installation

Introduction​

Next.js is a popular React framework that enables features such as server-side rendering, static site generation, and API routes, making it an excellent choice for building modern web applications. In this tutorial, you'll learn how to install Next.js and set up your first project.

Before we begin, you should have:

  • Basic knowledge of JavaScript and React
  • Node.js (version 16.8 or later)
  • npm (typically comes with Node.js) or yarn package manager

Installation Methods​

There are several ways to set up a Next.js project. We'll cover the most common methods:

  1. Using create-next-app (Recommended)
  2. Manual installation
  3. Adding Next.js to an existing project

Method 1: Using create-next-app​

The easiest way to get started with Next.js is by using create-next-app, which sets up everything automatically for you.

Basic Installation​

bash
npx create-next-app@latest my-next-app
# or
yarn create next-app my-next-app
# or
pnpm create next-app my-next-app

When you run this command, you'll be prompted with a series of configuration questions:

What is your project named? my-next-app
Would you like to use TypeScript? No / Yes
Would you like to use ESLint? No / Yes
Would you like to use Tailwind CSS? No / Yes
Would you like to use `src/` directory? No / Yes
Would you like to use App Router? (recommended) No / Yes
Would you like to customize the default import alias (@/*)? No / Yes

After answering these questions, the CLI will create a new directory with the name you specified and install all the necessary dependencies.

Project Structure​

After installation, your project folder will look something like this:

my-next-app/
├── node_modules/
├── public/
│   ├── favicon.ico
│   ├── next.svg
│   └── vercel.svg
├── app/
│   ├── favicon.ico
│   ├── globals.css
│   ├── layout.js
│   └── page.js
├── .eslintrc.json
├── .gitignore
├── jsconfig.json
├── next.config.js
├── package.json
└── README.md

Running Your Next.js Application​

Once the installation is complete, you can navigate to your project directory and start the development server:

bash
cd my-next-app
npm run dev
# or
yarn dev
# or
pnpm dev

This will start your Next.js app on http://localhost:3000. Visit this URL in your browser to see your new application.

Method 2: Manual Installation​

If you prefer setting up your project manually or want more control over the configuration, follow these steps:

Step 1: Create a new directory and initialize a package​

bash
mkdir my-manual-nextjs
cd my-manual-nextjs
npm init -y

Step 2: Install Next.js, React, and React DOM​

bash
npm install next react react-dom
# or
yarn add next react react-dom

Step 3: Add scripts to package.json​

Open the package.json file and add the following scripts:

json
"scripts": {
  "dev": "next dev",
  "build": "next build",
  "start": "next start",
  "lint": "next lint"
}

Step 4: Create basic folder structure​

bash
mkdir pages public styles

Step 5: Create a simple page​

Create a file pages/index.js:

jsx
export default function Home() {
  return (
    <div>
      <h1>Welcome to my Next.js App!</h1>
      <p>This is a manually configured Next.js application.</p>
    </div>
  );
}

Step 6: Run the development server​

bash
npm run dev
# or
yarn dev

Visit http://localhost:3000 to see your application.

Method 3: Adding Next.js to an Existing Project​

If you already have a React project and want to migrate to Next.js, follow these steps:

Step 1: Install Next.js​

bash
npm install next
# or
yarn add next

Step 2: Update package.json scripts​

json
"scripts": {
  "dev": "next dev",
  "build": "next build",
  "start": "next start",
  "lint": "next lint"
}

Step 3: Create a pages directory​

bash
mkdir pages

Step 4: Move your entry point​

Create a file pages/index.js with your main component. For example:

jsx
import React from 'react';
import YourExistingApp from '../components/YourExistingApp';

export default function Home() {
  return <YourExistingApp />;
}

Step 5: Adjust imports and routing​

You'll need to adjust your imports and routing to work with Next.js routing system.

Step 6: Run the development server​

bash
npm run dev
# or
yarn dev

Real-world Example: Creating a Blog with Next.js​

Let's create a simple blog application with Next.js to demonstrate a practical application.

Step 1: Install Next.js​

bash
npx create-next-app@latest my-blog
cd my-blog

Step 2: Create a blog post page​

Create a file pages/posts/[id].js for dynamic blog posts:

jsx
import { useRouter } from 'next/router';

// Mock data (in a real app, you would fetch this from an API or database)
const posts = {
  '1': {
    title: 'Getting Started with Next.js',
    content: 'Next.js is a React framework for production...',
    date: '2023-08-01'
  },
  '2': {
    title: 'Why Next.js is Great',
    content: 'Server-side rendering, static site generation...',
    date: '2023-08-05'
  }
};

export default function Post() {
  const router = useRouter();
  const { id } = router.query;
  
  // Handle loading state and non-existent posts
  if (router.isFallback || !posts[id]) {
    return <div>Loading...</div>;
  }
  
  const post = posts[id];
  
  return (
    <div>
      <h1>{post.title}</h1>
      <p>Published on {post.date}</p>
      <div>{post.content}</div>
      <button onClick={() => router.back()}>Back to posts</button>
    </div>
  );
}

Step 3: Create a posts index page​

Create a file pages/index.js:

jsx
import Link from 'next/link';

// Mock data
const posts = [
  { id: '1', title: 'Getting Started with Next.js', date: '2023-08-01' },
  { id: '2', title: 'Why Next.js is Great', date: '2023-08-05' }
];

export default function Home() {
  return (
    <div>
      <h1>My Next.js Blog</h1>
      <ul>
        {posts.map(post => (
          <li key={post.id}>
            <Link href={`/posts/${post.id}`}>
              <p>{post.title} - {post.date}</p>
            </Link>
          </li>
        ))}
      </ul>
    </div>
  );
}

Step 4: Run the development server​

bash
npm run dev

Visit http://localhost:3000 to see your blog application. You should see a list of blog posts, and clicking on any will take you to the post details page.

Common Installation Issues and Solutions​

Here are some common issues you might encounter when installing Next.js:

1. Node Version Issues​

Problem: Error messages related to Node.js version.

Solution: Make sure you're using Node.js version 16.8 or later.

bash
node -v
# If outdated, install a newer version using nvm or download from nodejs.org

2. Port Already in Use​

Problem: Error like "Port 3000 is already in use".

Solution: Use a different port.

bash
npm run dev -- -p 3001
# or
PORT=3001 npm run dev

3. Installation Freezing​

Problem: The installation process seems to get stuck.

Solution: Cancel the operation (Ctrl+C), clear npm cache, and try again.

bash
npm cache clean --force
# then retry the installation

Summary​

In this tutorial, you've learned:

  1. How to install Next.js using create-next-app (the recommended approach)
  2. How to manually set up a Next.js project
  3. How to add Next.js to an existing React application
  4. Creating a simple blog application with Next.js
  5. Common installation issues and their solutions

Next.js provides a powerful and flexible framework for building modern web applications. With the knowledge from this tutorial, you can now start developing feature-rich applications using Next.js.

Additional Resources​

Exercises​

  1. Create a Next.js application and add a custom page with a form that collects user information.
  2. Set up a Next.js project with TypeScript support.
  3. Create a small e-commerce product listing page using Next.js with dummy product data.
  4. Modify the blog example to fetch posts from a mock API (you can use JSONPlaceholder).
  5. Add styling to your Next.js application using CSS modules or a styling library like Tailwind CSS.

Happy coding with Next.js!


If you spot any mistakes on this website, please let me know at feedback@compilenrun.com. I’d greatly appreciate your feedback! :)