Git Product home page Git Product logo

generator-next-prismic's Introduction

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

generator-next-prismic's People

Contributors

jonanderdev avatar maciej-stefaniak avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.