generator-next-prismic

Create a next-prismic project with yo

This generator will create a project with React, Typescript and Next.js to allow server side rendering and improving SEO on our site. Also the result project will be connected to Prismic.io Headless CMS for retrieving data.

Installation

First, install Yeoman using npm (we assume you have pre-installed node.js).

npm install -g yo

Then clone this project and after installing dependencies link it.

git clone https://github.com/appico/generator-next-prismic.git
cd generator-next-prismic
npm i
npm link

Then to generate your new project (in any other folder) run the following:

yo next-prismic

To update the generator or to simply change the branch it points to, just go to the cloned project folder and update it with git

About the generated project

It will create a React Typescript based project using Next.js framework to allow server side rendering and improving SEO on the site. And all content of the site is fetched from Prismic through a simple API.

The app is set as a PWA (Progressive Web App) providing:

• Server-side rendering with Next.js
• A Node.js Express server with gzip compression
• In the server an API connected to Prismic to deliver content to the client
• Offline support with a service worker
• A manifest and robots.txt files
• Linting & code formatting with Eslint, Prettier ...
• Styling with SCSS files and with Autoprefixer. Also allows to add custom PostCSS config.
• A Redux store to get the content from the API

About the generator

The generator is done with Yeoman. Learn more about Yeoman.

Stay up to date

In order to stay up to date with the last version of this generator, run the following:

npm install -g generator-next-prismic

License

MIT © Appico