rsnext/examples/cms-prepr/README.md
Freddy Montes 15cc88909c
chore(examples): Add dotCMS example (#38214)
<!--
Thanks for opening a PR! Your contribution is much appreciated.
In order to make sure your PR is handled as smoothly as possible we
request that you follow the checklist sections below.
Choose the right checklist for the change that you're making:
-->

This adds a new example under cms-dotcms/. Is a general-purpose example
that should allow developers to undestand how to use next.js with dotCMS
apis.

## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have helpful link attached, see `contributing.md`

## Feature

- [ ] Implements an existing feature request or RFC. Make sure the
feature request has been accepted for implementation before opening a
PR.
- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [x] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have helpful link attached, see `contributing.md`

## Documentation / Examples

- [x] Make sure the linting passes by running `pnpm lint`
- [x] The examples guidelines are followed from [our contributing
doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples)

Co-authored-by: Daniel Esteves <estevesd8@gmail.com>
Co-authored-by: Will Ezell <will@dotcms.com>
Co-authored-by: Arcadio Quintero A <oidacra@gmail.com>
Co-authored-by: Rafael <rjvelazco21@gmail.com>
2022-10-01 15:26:13 +02:00

5.8 KiB

A statically generated blog example using Next.js and Prepr

This example showcases Next.js's Static Generation feature using Prepr as the data source.

Demo

https://next-blog-prepr.vercel.app/

Getting Started

Once you have access to the environment variables you'll need, deploy the example using Vercel:

Deploy with Vercel

How to use

Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:

npx create-next-app --example cms-prepr cms-prepr-app
yarn create next-app --example cms-prepr cms-prepr-app
pnpm create next-app --example cms-prepr cms-prepr-app

Configuration

Step 1. Create an account and a environment in Prepr

First, create an account in Prepr.

Step 2. Create Author model

From your Prepr dashboard, click Settings -> Models

Click on the arrow next to Add model and select Import.

Import the models/author.json file.

After that

Import the models/post.json file.

Step 3. Set up environment variables (for production)

Copy the .env.local.example file in this directory to .env.local (which will be ignored by Git):

cp .env.local.example .env.local

Inside your environment, navigate to Settings > Development > Access Tokens.

Click Add access token, enter the name Next.js Production and add the scope graphql_published and click Save.

Copy the generated access token and set the variable PREPRIO_PRODUCTION_TOKEN in .env.local.

Step 3.1 Set up environment variables (for preview)

Go back to the Access token overview and click Add access token.

Click Add access token, enter the name Next.js Preview and add the scope graphql_preview and click Save.

Copy the generated access token and set the variable PREPRIO_PREVIEW_TOKEN in .env.local.

The PREPRIO_PREVIEW_KEY can be any random string (but avoid spaces), like a UUID`, this is used for Preview Mode.

Step 4. Run Next.js in development mode

npm install
npm run dev

# or

yarn install
yarn dev

Your blog should be up and running on http://localhost:3000! If it doesn't work, post on GitHub discussions.

Step 5. Try preview mode

In Prepr, go to one of the posts in your environment and:

  • Update the title. For example, you can add [REVIEW] in front of the title.
  • After you edit the publication save the post with a review state.

To view the preview, transform the url to the following format: http://localhost:3000/api/preview?secret=<YOUR_SECRET_TOKEN>&slug=<SLUG_TO_PREVIEW> where <YOUR_SECRET_TOKEN> is the same secret you defined in the .env.local file and <SLUG_TO_PREVIEW> is the slug of one of the posts you want to preview.

You should now be able to see post that are in Review and Done state. To exit the preview mode, you can click on "Click here to exit preview mode" at the top.

Step 6. Deploy on Vercel

You can deploy this app to the cloud with Vercel (Documentation).

Deploy Your Local Project

To deploy your local project to Vercel, push it to GitHub/GitLab/Bitbucket and import to Vercel.

Important: When you import your project on Vercel, make sure to click on Environment Variables and set them to match your .env.local file.

Deploy from Our Template

Alternatively, you can deploy using our template by clicking on the Deploy button below.

Deploy with Vercel