• Stars
    star
    103
  • Rank 333,046 (Top 7 %)
  • Language
    JavaScript
  • Created about 3 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A one-click starter project for Next and Netlify

Next + Netlify Starter

Netlify Status

This is a Next.js v12 project bootstrapped with create-next-app and set up to be instantly deployed to Netlify!

This project is a very minimal starter that includes 2 sample components, a global stylesheet, a netlify.toml for deployment, and a jsconfig.json for setting up absolute imports and aliases. With Netlify, you'll have access to features like Preview Mode, server-side rendering/incremental static regeneration via Netlify Functions, and internationalized routing on deploy automatically.

Deploy to Netlify

(If you click this button, it will create a new repo for you that looks exactly like this one, and sets that repo up immediately for deployment on Netlify)

Table of Contents:

Getting Started

First, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.js. The page auto-updates as you edit the file.

Installation options

Option one: One-click deploy

Deploy to Netlify

Option two: Manual clone

  1. Clone this repo: git clone https://github.com/netlify-templates/next-netlify-starter.git
  2. Navigate to the directory and run npm install
  3. Run npm run dev
  4. Make your changes
  5. Connect to Netlify manually (the netlify.toml file is the one you'll need to make sure stays intact to make sure the export is done and pointed to the right stuff)

Testing

Included Default Testing

We’ve included some tooling that helps us maintain these templates. This template currently uses:

If your team is not interested in this tooling, you can remove them with ease!

Removing Renovate

In order to keep our project up-to-date with dependencies we use a tool called Renovate. If you’re not interested in this tooling, delete the renovate.json file and commit that onto your main branch.

Removing Cypress

For our testing, we use Cypress for end-to-end testing. This makes sure that we can validate that our templates are rendering and displaying as we’d expect. By default, we have Cypress not generate deploy links if our tests don’t pass. If you’d like to keep Cypress and still generate the deploy links, go into your netlify.toml and delete the plugin configuration lines:

[[plugins]]
  package = "netlify-plugin-cypress"
-  [plugins.inputs.postBuild]
-    enable = true
-
-  [plugins.inputs]
-    enable = false 

If you’d like to remove the netlify-plugin-cypress build plugin entirely, you’d need to delete the entire block above instead. And then make sure sure to remove the package from the dependencies using:

npm uninstall -D netlify-plugin-cypress

And lastly if you’d like to remove Cypress entirely, delete the entire cypress folder and the cypress.config.ts file. Then remove the dependency using:

npm uninstall -S cypress

More Repositories

1

gatsby-starter-netlify-cms

Example gatsby + netlify cms project
JavaScript
2,030
star
2

victor-hugo

Victor Hugo is a Hugo boilerplate for creating truly epic websites!
JavaScript
1,532
star
3

one-click-hugo-cms

Hugo template with Netlify CMS
SCSS
424
star
4

nextjs-blog-theme

A customizable Next.js and Tailwind blog starter. Designed by the Bejamas agency.
JavaScript
404
star
5

kpop-stack

Create a Remix app with Netlify, Tailwind, TypeScript and more!
TypeScript
231
star
6

jekyll-netlify-cms

A starter template for Jekyll and netlify CMS
HTML
138
star
7

kaldi-hugo-cms-template

**Deprecated. Check out one-click-hugo-cms instead.**
CSS
93
star
8

gatsby-ecommerce-theme

A Gatsby-based starter theme with e-commerce styled components
JavaScript
90
star
9

astro-toolbox

Netlify ❤️ Astro: a simple template to give you the code you need to use Netlify features with Astro.
Astro
66
star
10

astro-quickstart

A bare-bones Astro template to get you deployed to Netlify fast!
Astro
38
star
11

nextjs-toolbox

Netlify ❤️ Next.js: A sample to give you the code you need to use Netlify features with Next.js.
JavaScript
34
star
12

hexo-cms-example

An example hexo/netlify CMS integration
CSS
29
star
13

next-platform-starter

Modern starter based on Next.js 14 (App Router), Tailwind, daisyUI, and Netlify Core Primitives
JavaScript
29
star
14

nuxt-toolbox

Netlify ❤️ Nuxt.js: a simple template to give you the code you need to use Netlify features with Nuxt.
JavaScript
25
star
15

astro-platform-starter

A modern starter based on Astro.js, Tailwind, daisyUI, and Netlify Core Primitives (Edge Functions, Image CDN, Blob Store).
Astro
22
star
16

next-starter-jamstack

A Next.js starter for the JAMstack
JavaScript
21
star
17

hugo-quickstart

A bare-bones Hugo template to get you deployed to Netlify fast!
HTML
20
star
18

angular-quickstart

A bare-bones Angular template to get you deployed to Netlify fast!
TypeScript
19
star
19

astro-sanity-starter

Netlify Astro and Sanity starter with visual editing.
TypeScript
17
star
20

roots-cms-example

An example roots/netlify CMS integration
CSS
13
star
21

solid-quickstart

A Solid Quickstart template that will get you started with everything you need to build a Solid project
TypeScript
10
star
22

jekyll-base

Fresh Jekyll install from running "jekyll new ..."
SCSS
3
star
23

mkdocs-base

Fresh Cactus install from "mkdocs new ..."
3
star
24

roots-base

Fresh Roots install from "roots new ..."
Stylus
1
star
25

hexo-base

Fresh Hexo install from "hexo init ..."
Stylus
1
star
26

hugo-base

Fresh Hugo Install from "hugo new site ..."
HTML
1
star