|
| 1 | +# Next + Netlify Starter |
| 2 | + |
| 3 | +[](https://app.netlify.com/sites/next-dev-starter/deploys) |
| 4 | + |
| 5 | +This is a [Next.js](https://nextjs.org/) v14 project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) and set up to be instantly deployed to [Netlify](https://url.netlify.com/SyTBPVamO)! |
| 6 | + |
| 7 | +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. |
| 8 | + |
| 9 | +[](https://app.netlify.com/start/deploy?repository=https://github.com/netlify-templates/next-netlify-starter&utm_source=github&utm_medium=nextstarter-cs&utm_campaign=devex-cs) |
| 10 | + |
| 11 | +(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) |
| 12 | + |
| 13 | +## Table of Contents: |
| 14 | + |
| 15 | +- [Getting Started](#getting-started) |
| 16 | +- [Installation options](#installation-options) |
| 17 | +- [Testing](#testing) |
| 18 | + - [Included Default Testing](#included-default-testing) |
| 19 | + - [Removing Renovate](#removing-renovate) |
| 20 | + |
| 21 | +## Getting Started |
| 22 | + |
| 23 | +First, run the development server: |
| 24 | + |
| 25 | +```bash |
| 26 | +npm run dev |
| 27 | +# or |
| 28 | +yarn dev |
| 29 | +``` |
| 30 | + |
| 31 | +Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. |
| 32 | + |
| 33 | +You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file. |
| 34 | + |
| 35 | +### Installation options |
| 36 | + |
| 37 | +**Option one:** One-click deploy |
| 38 | + |
| 39 | +[](https://app.netlify.com/start/deploy?repository=https://github.com/netlify-templates/next-netlify-starter&utm_source=github&utm_medium=nextstarter-cs&utm_campaign=devex-cs) |
| 40 | + |
| 41 | +**Option two:** Manual clone |
| 42 | + |
| 43 | +1. Clone this repo: `git clone https://github.com/netlify-templates/next-netlify-starter.git` |
| 44 | +2. Navigate to the directory and run `npm install` |
| 45 | +3. Run `npm run dev` |
| 46 | +4. Make your changes |
| 47 | +5. Connect to [Netlify](https://url.netlify.com/Bk4UicocL) 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) |
| 48 | + |
| 49 | +## Testing |
| 50 | + |
| 51 | +### Included Default Testing |
| 52 | + |
| 53 | +We’ve included some tooling that helps us maintain these templates. This template currently uses: |
| 54 | + |
| 55 | +- [Renovate](https://www.mend.io/free-developer-tools/renovate/) - to regularly update our dependencies |
| 56 | +- [Cypress](https://www.cypress.io/) - to run tests against how the template runs in the browser |
| 57 | +- [Cypress Netlify Build Plugin](https://github.com/cypress-io/netlify-plugin-cypress) - to run our tests during our build process |
| 58 | + |
| 59 | +If your team is not interested in this tooling, you can remove them with ease! |
| 60 | + |
| 61 | +### Removing Renovate |
| 62 | + |
| 63 | +In order to keep our project up-to-date with dependencies we use a tool called [Renovate](https://github.com/marketplace/renovate). If you’re not interested in this tooling, delete the `renovate.json` file and commit that onto your main branch. |
0 commit comments