Skip to content

Latest commit

 

History

History
124 lines (78 loc) · 6.2 KB

README.md

File metadata and controls

124 lines (78 loc) · 6.2 KB
Raw

Prismic + Next.js Minimal TypeScript Starter

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

 

Website screenshot

 

🚀 Quick Start

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

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

The commands will do the following:

  1. Start a new Next.js 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 chose this starter when you created a new repository from the Prismic Dashboard, then your repository is preconfigured with previews on localhost. To change the preview configuration or add previews to your production or staging environments, see Preview Drafts in Next.js in the Prismic documentation.

Customize this website

This website is preconfigured with Prismic. It has three Prismic packages installed:

  • @prismicio/client provides helpers for fetching content from Prismic
  • @prismicio/react provides React components for rendering content from Prismic
  • @prismicio/next provides a wrapper component to configure Prismic previews

These packages are already integrated and employed in this app. Take a look at the code to see how they're used.

Edit the code

There are two steps to rendering content from Prismic in your Next.js project:

  1. Fetch content from the Prismic API using @prismicio/client.
  2. Template the content using components from @prismicio/react.

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

  • prismicio.ts - This file includes configuration for @prismicio/client and exports useful API helpers.
  • pages/\_app.tsx - This is your app component, which includes configuration for @prismicio/react and @prismicio/next.
  • pages/index.tsx - This is the app homepage. It queries and renders a page document with the UID (unique identifier) "home" from the Prismic API.
  • pages/[uid].tsx - This is the page component, which queries and renders a page document from your Prismic repository based on the UID.
  • slices/\*/index.tsx - Each Slice in your project has an index.js file that renders the Slice component. Edit this file to customize your Slices.

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

  • pages/api/exit-preview.ts - Do not edit or delete this file. This is the API endpoint to close a Prismic preview session.
  • pages/api/preview.ts - Do not edit or delete this file. This is the API endpoint to launch a Prismic preview session.
  • pages/slice-simulator.tsx - 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.js 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 Next.js and Template Content in Next.js.

Learn more about how to use TypeScript with Prismic.

Deploy to the web

To put your project online, see Deploy your Next.js 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 Next.js.

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 Next.js.

Documentation

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

License

Copyright 2013-2022 Prismic <[email protected]> (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.