Migrating from Create React App to NextJS: A Practical Guide
Last Updated :
01 Aug, 2024
Migrating from Create React App (CRA) to Next.js involves transitioning from a client-side rendered React application to a framework that offers server-side rendering, static site generation, and built-in routing capabilities. This guide provides a step-by-step approach to help you effectively migrate your project and take advantage of Next.js's powerful features.
Steps to Migrate from React App to Next JS
Step 1: Initialize React Project
Run the following command in your terminal:
npx create-react-app myReactApp
Once the installation is complete, you will see a message :
Happy hacking!
Step 2: Switch to Project directory
Now we can navigate into the project:
cd myReactApp
Step 3: Run the project
Use the below command to run the project
npm run start
This will produce the following message:
Starting the development server…
Compiled successfully!
You can now view trial in the browser.
Local: http://localhost:3000
This means the local server is up and running and once you open your browser and navigate to http://localhost:3000, you should see your React application:
-min-660.png)
Project Structure :
.png)
- node_modules folder contains all dependencies for our project.
- public folder contains static assets like images which are publicly accessible. It also has an index.html file which is the entry point of our application. This file has an empty div with the id of "root"
- src folder is the place for all the components of our app. It also has all the css files. The index.js file is the JavaScript entry point for the application, it grabs the empty div with the id of "root" and populates it with the App.js component.
Step 4: Remove react scripts
First uninstall react-scripts dependencies which was installed with the create-react-app tool.
npm uninstall react-scripts
Step 5: Install Next.js dependencies
Now we will install the "next" dependency. Run the following command in your terminal :
npm install next
After this we need to change the scripts inside the package.json file. Head to your package.json file and locate the "scripts" object. It should look something like this :
old package.jsonChange it and add NextJS scripts as follows :
new package.jsonStep 6: add TypeScript support
We also need to install typescript which is the default language for NextJs apps.
npm install -g typescript
After this, run the following command in your terminal which will create a tsconfig.json file, required for running the TypeScript code:
tsc --init
In the end your package.json file should look like this:
"dependencies": {
"@testing-library/jest-dom": "^5.17.0",
"@testing-library/react": "^13.4.0",
"@testing-library/user-event": "^13.5.0",
"@types/react": "^18.2.48",
"@types/react-dom": "^18.2.18",
"next": "^14.1.0",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"web-vitals": "^2.1.4"
}Step 7: Set up project components
Creating Pages:
- Leave the public folder as it is.
- Delete the index.html file as we no longer need it.
- Create a folder called "app" in the root level of the project.
- Inside the app directory, create a layout.tsx file. Add the following code to the layout.tsx file:
JavaScript
// layout.tsx
export const metadata = {
title: 'My Next JS App',
description:
'Migrating from create-react-app to NextJS : a practical guide',
}
export default function RootLayout({
children,
}: {
children: React.ReactNode
}) {
return (
<html lang="en">
<body>
<h2>Coding is fun!</h2>
{children}
</body>
</html>
)
}
- This is the root layout of the website, meaning the entire app will follow this layout.
- Here we have added an H2 before rendering the {children}. This means that the H2 text will always appear on all the pages, and below it the page content will be rendered.
- Now inside app folder, create another file called page.tsx
- Copy and paste the following piece of code inside page.tsx file:
JavaScript
// page.tsx
import React from 'react'
export default function App(){
return(
<>
<p>This is the home page of my website</p>
</>
)
}
Step 9: Define custom component
Components in NextJs create a components folder in the root level of the project and add a file called "myButton.tsx" inside it, which will have the following simple piece of code :
JavaScript
// myButton.tsx
import React from "react"
export default function MyButton() {
return (
<>
<button>CLICK ME!</button>
</>
)
}
Now let us create an "About" page for our app which will call this button. Inside the app directory, create a folder called "about" and add a "page.tsx" file inside it with the following piece of code :
JavaScript
// page.tsx
import React from "react";
import MyButton from "../../components/myButton";
export default function About(){
return(
<>
<p>This is the about page</p>
<MyButton/>
</>
)
}
Output: Navigate to "http://localhost:3000/about" in your web browser and it should look like this :
Conclusion
Migrating from Create React App to Next.js involves transitioning to a more powerful framework that offers server-side rendering, static site generation, and improved routing. By following this guide, you can systematically migrate your application, leveraging Next.js’s features to enhance performance and user experience.
Similar Reads
React Tutorial React is a powerful JavaScript library for building fast, scalable front-end applications. Created by Facebook, it's known for its component-based structure, single-page applications (SPAs), and virtual DOM,enabling efficient UI updates and a seamless user experience.Note: The latest stable version
7 min read
React Fundamentals
React IntroductionReactJS is a component-based JavaScript library used to build dynamic and interactive user interfaces. It simplifies the creation of single-page applications (SPAs) with a focus on performance and maintainability.React.jsWhy Use React?Before React, web development faced issues like slow DOM updates
8 min read
React Environment SetupTo run any React application, we need to first setup a ReactJS Development Environment. In this article, we will show you a step-by-step guide to installing and configuring a working React development environment.Pre-requisite:We must have Nodejs installed on our PC. So, the very first step will be
3 min read
React JS ReactDOMReactDom is a core react package that provides methods to interact with the Document Object Model or DOM. This package allows developers to access and modify the DOM. Let's see in brief what is the need to have the package. Table of ContentWhat is ReactDOM ?How to use ReactDOM ?Why ReactDOM is used
3 min read
React JSXJSX stands for JavaScript XML, and it is a special syntax used in React to simplify building user interfaces. JSX allows you to write HTML-like code directly inside JavaScript, enabling you to create UI components more efficiently. Although JSX looks like regular HTML, it’s actually a syntax extensi
6 min read
ReactJS Rendering ElementsIn this article we will learn about rendering elements in ReactJS, updating the rendered elements and will also discuss about how efficiently the elements are rendered.What are React Elements?React elements are the smallest building blocks of a React application. They are different from DOM elements
3 min read
React ListsReact Lists are used to display a collection of similar data items like an array of objects and menu items. It allows us to dynamically render the array elements and display repetitive data.Rendering List in ReactTo render a list in React, we will use the JavaScript array map() function. We will ite
5 min read
React FormsForms are an essential part of any application used for collecting user data, processing payments, or handling authentication. React Forms are the components used to collect and manage the user inputs. These components include the input elements like text field, check box, date input, dropdowns etc.
5 min read
ReactJS KeysA key serves as a unique identifier in React, helping to track which items in a list have changed, been updated, or removed. It is particularly useful when dynamically creating components or when users modify the list. In this article, we'll explore ReactJS keys, understand their importance, how the
5 min read
Components in React
React ComponentsIn React, React components are independent, reusable building blocks in a React application that define what gets displayed on the UI. They accept inputs called props and return React elements describing the UI.In this article, we will explore the basics of React components, props, state, and render
4 min read
ReactJS Functional ComponentsIn ReactJS, functional components are a core part of building user interfaces. They are simple, lightweight, and powerful tools for rendering UI and handling logic. Functional components can accept props as input and return JSX that describes what the component should render.What are Reactjs Functio
5 min read
React Class ComponentsClass components are ES6 classes that extend React.Component. They allow state management and lifecycle methods for complex UI logic.Used for stateful components before Hooks.Support lifecycle methods for mounting, updating, and unmounting.The render() method in React class components returns JSX el
4 min read
ReactJS Pure ComponentsReactJS Pure Components are similar to regular class components but with a key optimization. They skip re-renders when the props and state remain the same. While class components are still supported in React, it's generally recommended to use functional components with hooks in new code for better p
4 min read
ReactJS Container and Presentational Pattern in ComponentsIn this article we will categorise the react components in two types depending on the pattern in which they are written in application and will learn briefly about these two categories. We will also discuss about alternatives to this pattern. Presentational and Container ComponentsThe type of compon
2 min read
ReactJS PropTypesIn ReactJS PropTypes are the property that is mainly shared between the parent components to the child components. It is used to solve the type validation problem. Since in the latest version of the React 19, PropeTypes has been removed. What is ReactJS PropTypes?PropTypes is a tool in React that he
5 min read
React Lifecycle In React, the lifecycle refers to the various stages a component goes through. These stages allow developers to run specific code at key moments, such as when the component is created, updated, or removed. By understanding the React lifecycle, you can better manage resources, side effects, and perfo
7 min read
React Hooks
Routing in React
Advanced React Concepts
React Projects