README.md

Launching this project with Prismic CMS

This page will show you how to launch a new Prismic repository with all the default content you need to get started.

Clone the default Prismic repo

The Prismic command line interface will help get your Prismic repo launched. First install the CLI.

yarn global add prismic-cli

Note: make sure to update to least version 3.8.4 of the prismic-cli if you already have it installed on your machine.

Then you can clone the project and launch a Prismic repository.

prismic theme --theme-url https://github.com/vercel/virtual-event-starter-kit/archive/main.zip --conf lib/cms-providers/prismic/README.md --custom-types lib/cms-providers/prismic/custom_types --documents lib/cms-providers/prismic/documents

Note that you will likely need to log into your Prismic account or signup. After that, the command will download the project files, create a Prismic repository, & install the project dependencies.

Running Locally

First, set local environment variables in .env.local.example.

cp .env.local.example .env.local

Then update the environment variables with your Prismic repo ID. Your repo id will the be subdomain of your Prismic repository. For example if your repo url is https://your-repo-name.prismic.io, then you would update your .env.local file as follows:

PRISMIC_REPO_ID=your-repo-name

From the root of the project, run the development server:

yarn dev

Open http://localhost:3000 with your browser to see the result.

Deploy