https://github.com/michaelcurrin/next-quickstart

Starter template for a Next.js app with docs and CI
https://github.com/michaelcurrin/next-quickstart

boilerplate nextjs node quickstart template

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/michaelcurrin/next-quickstart
• Owner: MichaelCurrin
• License: mit
• Created: 2020-10-27T12:59:22.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-06-02T15:18:29.000Z (about 2 years ago)
• Last Synced: 2025-03-04T15:47:27.562Z (over 1 year ago)
• Topics: boilerplate, nextjs, node, quickstart, template
• Language: JavaScript
• Homepage:
• Size: 232 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Next.js Quickstart

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

[![Node CI](https://github.com/MichaelCurrin/next-js-quickstart/workflows/Node%20CI/badge.svg)](https://github.com/MichaelCurrin/next-js-quickstart/actions)

[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/next-js-quickstart)](https://github.com/MichaelCurrin/next-js-quickstart/releases/)

[![License](https://img.shields.io/badge/License-MIT-blue)](#license "Go to license section")

[![Made with Node](https://img.shields.io/badge/Node.js->=14-blue?logo=node.js&logoColor=white)](https://nodejs.org)

[![Package - next](https://img.shields.io/github/package-json/dependency-version/MichaelCurrin/next-quickstart/next?logo=next.js)](https://www.npmjs.com/package/next)

[![Package - react](https://img.shields.io/github/package-json/dependency-version/MichaelCurrin/next-quickstart/react?logo=react)](https://www.npmjs.com/package/react)

## Preview



    



## Use this project



[![Use this template](https://img.shields.io/badge/generate-Use_this_template-2ea44f?style=for-the-badge)](https://github.com/MichaelCurrin/next-quickstart/generate)



## 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](https://michaelcurrin.github.io/dev-resources/resources/javascript/packages/next/) resources to learn more.

### Create a fresh project from scratch

From [Create a Next.js App](https://nextjs.org/learn/basics/create-nextjs-app) tutorial on the homepage using [vercel/next-learn](https://github.com/vercel/next-learn) repo.

```sh

$ 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](/pages/) directory with one JS file.

- [public](/public/) directory with an SVG logo and favicon.

- [.gitignore](/.gitignore) file.

- [package.json](/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](/.github/workflows/main.yml).

- Docs (see below).

For adding ESLint to your project, see [ESLint](https://nextjs.org/docs/pages/building-your-application/configuring/eslint) configuration guide for Next.

## Documentation

> How to install, run and deploy this project



[![View Project Docs](https://img.shields.io/badge/View-Project_Docs-blue?style=for-the-badge)](/docs/ "Go to project docs")



## License

Released under [MIT](/LICENSE) by [@MichaelCurrin](https://github.com/MichaelCurrin).