Install Prismic
This article explains how to install and configure Prismic in a SvelteKit project. By the end of this page, you will have Prismic utilities installed in your app.
To start building quickly, go to prismic.io/dashboard, select SvelteKit, and choose a starter.
This guide assumes basic knowledge of Svelte and SvelteKit. If you are new to development with either, see the official introductions for Svelte and SvelteKit.
Before proceeding, you will need a SvelteKit project. You can quickly create a brand new project using the following create-svelte command. (Read the official documentation to learn more):
- npm
- Yarn
npm create svelte@latestyarn create svelte@latestThis command will prompt an option to name your project. After that you'll be able to open your newly created SvelteKit app.
Once it's finished, you'll have a brand new SvelteKit project where you can install Slice Machine.
In the root of your SvelteKit project, run the following command:
npx @slicemachine/init@latestWhat happens when you run @slicemachine/init?
The command executes the following actions in your codebase:
- Creates a new Prismic repository (or lets you specify an existing one)
- Adds a
start-slicemachinescript topackage.json - Creates a
slicemachine.config.jsonfile containing the name of your Prismic repository and the location of your slice library - Creates a
prismicio.js|tsfile in thesrc/lib/directory of your project to configure Prismic - Detects your framework (SvelteKit)
- Installs dependencies:
@prismicio/client,@prismicio/svelte,slice-machine-ui, and@slicemachine/adapter-sveltekit - Creates a
src/routes/slice-simulator/+page.sveltefile to simulate slices
That might seem like a lot of dependencies. Don't worry, they each perform an important function:
@prismicio/clientis responsible for fetching data from the Prismic API@prismicio/svelteprovides Svelte components to render data from the Prismic APIslice-machine-uiis a local development tool for building slices@slicemachine/adapter-sveltekitis the SvelteKit adapter for Slice Machine
We also mentioned that the init command creates a src/routes/slice-simulator/+page.svelte file. What does that file do? The simulator is a mini-app that simulates what your slices will look like in production. The slice simulator uses an iframe, which runs locally, to simulate your slices. The mock data is provided by Slice Machine and is customizable. (See What Is Slice Machine? for more information.)
The init script creates a file called prismicio.js in the src/lib/ directory of your project. This file contains configurations for your project.
The most important configuration is the routes array, which is your route resolver. Update the route resolver to match the routing structure of your SvelteKit app. To learn more about how to add configurations, see the documentation for the route resolver and @prismicio/client.
The prismicio.js file is prefilled with an example routes array:
const routes = [
{
type: 'homepage',
path: '/',
},
{
type: 'page',
path: '/:uid',
},
]In prismicio.js, customize the routes array to match the routing of your project. For each page type, add an object that describes the route for that page. Learn more about how the route resolver works.
You now have Prismic utilities available throughout your project.
Now you can start creating slices and types to model your project.
Can't find what you're looking for?
Need technical Support? Spot an error in the documentation? Get in touch with us on our Community Forum.