Prismic + Nuxt Minimal Starter

Want to quickly get started building your own project with Prismic and Nuxt? This project includes basic configurations and nothing else. The project includes one Rich Text Slice, a homepage, and a dynamic page.

• Demo: Open live demo
• Learn more about Prismic and Nuxt: Prismic Nuxt Documentation

 

 

🚀 Quick Start

To start a new project using this starter, run the following commands in your terminal:

npx degit prismicio-community/nuxt-starter-prismic-minimal your-project-name
cd your-project-name
npx @slicemachine/init@latest

The commands will do the following:

1. Start a new Nuxt project using this starter.
2. Ask you to log in to Prismic or create an account.
3. Create a new Prismic content repository with sample content.

When you're ready to start your project, run the following command:

npm run dev

How to use your project

To edit the content of this project, go to prismic.io/dashboard, click on the repository for this website, and start editing.

Create a page

To create a page, click on the green pencil icon, then select Page.

Pages are made of Slices. You can add and rearrange Slices to your pages.

Your new page will be accessible by its URL, but it won't appear on the website automatically. To let users discover it, add it to the navigation.

Preview documents

If you launched this starter when you created a new repository in the Prismic Dashboard, then your repository is preconfigured with previews in development on localhost:3000.

To add a production preview, option your repository and go to Settings > Previews. Under Create a New Preview, fill in the three fields:

• a name (like Production)
• the domain where your app is running (like https://www.yoursite.com)
• /api/preview for the Preview Route

Now, go to a draft document and click the eye icon in the top-right corner.

To learn more about how to configure previews, read Preview Drafts in Nuxt in the Prismic documentation.

Customize this website

This website is preconfigured with Prismic. Functionality is provided by the @nuxtjs/prismic package, which makes Prismic utilities available throughout the app. Take a look at the code to see how it's used.

Edit the code

There are two steps to rendering content from Prismic in your Nuxt project:

1. Fetch content from the Prismic API
2. Template the content

Here are some of the files in your project that you can edit:

• nuxt.config.js - The prismic property includes configurations for @nuxtjs/prismic.
• pages/index.vue - This is the app homepage. It queries and renders a page document with the UID (unique identifier) "home" from the Prismic API.
• pages/[uid].vue - This is the page component, which queries and renders a page document from your Prismic repository based on the UID.
• slices/RichText/index.vue - Each Slice has an index.vue file that renders the Slice component. Edit this file to customize your Slices.

These are important files that you should leave as-is:

• pages/slice-simulator.vue - Do not edit or delete this file. This file simulates your Slice components in development.
• slices/ - This directory contains Slice components, which are generated programmatically by Slice Machine. To customize a Slice template, you can edit the Slice's index.vue file. To add Slices, delete Slices, or edit Slice models, use Slice Machine (more info below).

Learn more about how to edit your components with Fetch Data in Nuxt and Template Content in Nuxt.

Deploy to the web

To put your project online, see Deploy your Nuxt App.

Edit content models with Slice Machine

This project includes an application called Slice Machine, which generates models for your Custom Types and Slices. Slice Machine stores the models locally in your codebase, so you can save and version them. It also syncs your models to Prismic. To learn how to use Slice Machine, read Model Content in Nuxt.

If you change or add to your Custom Types, you'll need to update your route handling to match. To learn how to do that, read Define Paths in Nuxt.

Documentation

For the official Prismic documentation, see Prismic's guide for Nuxt or the technical references for the installed Prismic packages.

License

Copyright 2013-2023 Prismic <contact@prismic.io> (https://prismic.io)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.