This is a template repository for new Next.js projects. It includes some opinionated defaults that I'm sick of recreating every time I start a new project:
- Styled-Components with a
theme.js
file that follows the System UI Theme Specification - A
<GlobalStyle />
component based heavily on Andy Bell's Modern CSS Reset and included on all pages via a custom_app.js
- EditorConfig set to 2 spaces
- ESLint with
eslint-config-airbnb
,eslint-plugin-react
, andeslint-plugin-prettier
- A
.prettierrc
file with a few custom settings
Original Next.js README follows below...
This is a Next.js project bootstrapped with create-next-app
.
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.
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!
The easiest way to deploy your Next.js app is to use the ZEIT Now Platform from the creators of Next.js.
Check out our Next.js deployment documentation for more details.