Add the Dev Tools to an Existing Project

Beta

These docs rely on Slice Machine, which is in active development and subject to change. Content Relationships are not currently supported with Slices.

On this page, you'll learn how to add The Prismic Dev Tools to an existing Next.js project including any dependencies you might need.


1. Install Node

Node.js is used to power most modern Javascript frameworks to help you build websites fast and easily. Using Node.js, you can work with Javascript outside the browser. NPM (Node Package Manager) is used to install the various node dependencies used to power the Slice Machine. Luckily this installation process is something that is very well documented already.

So we'll allow William Vincent and his slick tutorials to take you through the process.

Before you start - Node Version

For this project to work correctly, you will need to have at least version 12.16.1 of node installed on your machine. You can check this by running the node -v command in your terminal.


2. Create a New Default Next App

For this example, you can download a default Next.js app to build on top of. Do this by running the following command (You can see the full guide for creating a Next app here):

  • npx
  • Yarn
Copy
npx create-next-app my-new-nextjs-app
Copy
yarn create-next-app my-new-nextjs-app

Once it is finished, the Create Next app command will install all the dependencies for the default Next.js app. To see your newly created app navigate to the project folder and launch it:

  • npm
  • Yarn
Copy
cd my-new-nextjs-app && npm run dev
Copy
cd my-new-nextjs-app && yarn dev

3. Install the Prismic CLI

So now we'll install the Prismic CLI (command line interface), if you haven't already. This tool will allow you to interact with Prismic from your local machine for things like creating repositories. To install it globally run the following command.

  • npm
  • Yarn
Copy
npm install -g prismic-cli
Copy
yarn global add prismic-cli

Sometimes it's possible that a global (-g) command like this doesn't work because of permission levels on your machine.

If that's the case for you, try executing the sudo command below:

  • npm
  • Yarn
Copy
sudo npm install -g prismic-cli
Copy
sudo yarn global add prismic-cli

CLI Version

You will need to make sure you're using the latest version of the CLI, which you can check on npm. (Check your version by running prismic --version).


4. Sign in to Prismic with the CLI

If You Don't Have a Prismic Account

After installing the CLI you should be able to create a Prismic account by running the following command:

Copy
prismic signup

If You Already Have a Prismic Account

After making sure that you have the correct version of the CLI, you can log in to Prismic by running the following command.

Copy
prismic login

5. Run the Prismic Setup Command

The following command will automagically configure your project with tools to start your Prismic development journey.

Copy
prismic sm --setup

What Does This Command Do?

This command does a lot of different things for you, including:

  • This option on the command will automatically connect our default Component Library and add any dependencies necessary to use the tool. This is done by adding extra configurations to your next.config.js file.
  • Adding the sm.json file with the default configuration.
  • Adding the sm-resolver.json file.
  • Creating a Prismic repository with a standard "Page" custom type. You should receive a confirmation email, and you can see your new repo by the following link from the email you received or by going directly to Prismic.
  • Installing dependencies required by Slice Machine and the library you selected, like node-sasssass-loader, and essential-slices
  • Installing libraries to fetch and display Prismic data like @prismicio/clientnext-slicezone@storybook/react, and next


Related Articles


Was this article helpful?
Not really
Yes, Thanks

Can't find what you're looking for? Get in touch with us on our Community Forum.