Set Up Content Migration Framework (Windows)

The Contentstack Migration Framework is designed to help users seamlessly migrate content from a legacy Content Management System (CMS) to Contentstack. The framework simplifies the migration process by providing an intuitive interface and step-by-step workflow for importing content, mapping content types, and migrating data into a stack within Contentstack. This guide outlines the process for installing the migration framework.

Note: If you are migrating Sitecore data, setting up the Migration Framework via Docker is recommended. Refer to the Set Up Content Migration Framework (Docker) document for detailed instructions.

Prerequisites

Before you begin the installation process, ensure that you have the following prerequisites:

GitHub account
Node.js version 21
npm version 10 or above
pnpm version 10 or above
Exported data from your legacy CMS that you wish to migrate (e.g., a ZIP, JSON, or other supported file type depending on your legacy CMS)

Installing the Migration Framework

Follow the steps below to install the migration framework on your system:

Open a terminal and run the following command to clone the repository and install dependencies:

git clone  https://github.com/contentstack/migration-v2.git && cd migration-v2 && setup-nvm.bat

If prompted, enter your system password to allow installation of any missing dependencies.
During the setup, select the legacy CMS you are migrating content from.

Warning: Ensure you select the correct legacy CMS to avoid any errors during the migration.
Enter the file path of the exported content you wish to migrate. For example: /Users/<username>/Downloads/<exported_data>.zip.
Note: The file type may vary depending on your legacy CMS. For example, Sitecore data is exported in ZIP format whereas Contentful data is exported in JSON.
If the installation is successful, a browser window should open automatically with the http://localhost:3000 URL.