Configure Your 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.

We'll be getting everything we need for this tutorial series setup and prepared. This includes downloading the initial project files, launching a Prismic repository, and installing the required dependencies.

Before you start - Node Version

You need at least Node.js 12.0 or later. Check this by running node -v in your terminal.


1. 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).


2. Install the Nuxt.js/Prismic boilerplate project

The following command will download and automatically configure a project with tools to start your Prismic development journey.

Copy
prismic theme --theme-url https://github.com/prismicio-community/slice-machine-starter-nuxt --conf sm.json

What does this command do?

This command does a lot of different things for you, including downloading a boilerplate project to get you up and running with all the necessary libraries to fetch and display Prismic data like  @prismicio/vue@nuxtjs/prismicnuxt-sm and slicebuilder-ui (used to build you, content models, locally).

It also creates 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.


Next and previous 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.