Skip to content

MichaelCurrin/next-quickstart

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

85 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Next.js Quickstart

Starter template for a Next.js app with docs and CI

Node CI GitHub tag License

Made with Node

Package - next Package - react

Preview

Sample screenshot

Use this project

Use this template

About

This is a static website built on Next.js, which is a framework built on React.

Next.js is "The React Framework for Production".

As with React, you can build more advanced web apps but in this case this template uses a simple site which can be hosted as static site. You can look into use Vercel as a host if you want server-side rendering.

See Next.js resources to learn more.

Create a fresh project from scratch

From Create a Next.js App tutorial on the homepage using vercel/next-learn repo.

$ npx create-next-app@latest \
  nextjs-blog \
  --use-npm \
  --example "https://github.com/vercel/next-learn/tree/main/basics/learn-starter"
$ cd nextjs-blog

That will create:

  • pages directory with one JS file.
  • public directory with an SVG logo and favicon.
  • .gitignore file.
  • package.json - it comes with Next 11 but I've set up Next 12 for my template here.
  • README.md file - with just one line.

This template project extends the base project by adding:

  • GH Actions CI flow - main.yml.
  • Docs (see below).

For adding ESLint to your project, see ESLint configuration guide for Next.

Documentation

How to install, run and deploy this project

View Project Docs

License

Released under MIT by @MichaelCurrin.

About

Starter template for a Next.js app with docs and CI

Topics

Resources

License

Stars

Watchers

Forks

Contributors 2

  •  
  •