create-nextjs-skeleton v1.1.2-canary.0

Next.js Skeleton

A simple and highly customizable skeleton build with Turborepo and Next. The skeleton is bootstrapped with create-next-app and has the following features:

• ESLint
• Security headers
• Preact
• Prettier
• Sass
• Turborepo
• TypeScript
• SVGR

Table of contents

• Next.js Skeleton - Table of contents - 1. Setup - 1.1 Node.js - 1.2 How to install this template - 1.3 TypeScript - 1.4 Preact - 2. Scripts - 3. Security - 4. Styling - 5. Search engine optimization - 5.1 Meta - 5.2 Schema - 6. Environment variables - 7. Vercel CLI - 8. Remote caching

1. Setup

1.1 Node.js

First install the Node.js higher or equal to 14.0.0. Use the JavaScript Tool Manager Volta or the Node Version Manager.

1.2 How to install this template

After successfully installing Node.js you can create an app using this skeleton. We recommend creating a new app using npx or yarn create, which sets up everything automatically for you. To create a project, run:

npx create-nextjs-skeleton
# or
npm init nextjs-skeleton
# or
yarn create nextjs-skeleton

1.3 TypeScript

This skeleton uses TypeScript out of the box. If you don't feel comfortable using it or don't need it, just rename all the files to their JavaScript equivalent (.js and .jsx) and uninstall TypeScript and all the @types listed in the package.json.

1.4 Preact

Besides TypeScript, this skeleton uses Preact over React for production builds. This results in smaller build and the same developer experience. Want to switch back to React? Simply delete or comment out the code below in next.config.js and uninstall the package.

webpack: ( config, { dev } ) => {
	if ( !dev ) {
		Object.assign( config.resolve.alias, {
			react: 'preact/compat',
			'react-dom/test-utils': 'preact/test-utils',
			'react-dom': 'preact/compat',
		} )
	}

	return config
}

2. Scripts

• Use yarn dev to start a local dev server for all projects
• Use yarn dev --scope=<app> to start a local dev server for that project on e.g: http://localhost:3000
• To test the code using ESLint, use yarn lint
• To build the application for production, use yarn build lint --scope=<app>
• To start a production server, open an app folder and use yarn start

3. Security

By default, Next doesn't provide all the security headers which results in a vulnerable application. I've added the default security headers listed in the Next docs. To test your application for security headers, visit securityheaders.com

4. Styling

With Next there's a lot of options to style your projects. This skeleton uses Sass Modules, Modern Normalize and some unit functions inspired by Foundation sites, but use whatever works best for you. For example:

• A global stylesheet
• CSS-in-JS
• styled-components
• Material-UI
• Tailwind CSS

5. Search engine optimization

5.1 Meta

I've created a <Meta> component which adds all the properties required regarding SEO. You can set up default props or feed it dynamically with data.

5.2 Schema

I've also created a <Schema> component to add schema markup for WebSite and WebPage to your side. You can also set up default props or feed it dynamically with data.

6. Environment variables

Next has built-in support for environment variables and the option to expose variables to the browser by prefixing with NEXT_PUBLIC_.

7. Vercel CLI

Whenever possible, I recommend deploying to Vercel. It's free, easy to use and gets you running within minutes (hint: This template was deployed via Vercel). A few commands to get you started:

• Install Vercel CLI with npm install -g vercel
• Connect a project with vercel link and configure credentials accordingly
• Use vercel env pull to get the environment variables
• Use vercel dev to deploy a local test server at http://localhost:3000
• Use vercel to deploy a preview build
• Use vercel --prod to deploy a production build

8. Remote caching

With Turborepo, you can connect to the Vercel Remote Cache to share build artifacts. You first need to authenticate the Turborepo CLI with your Vercel account using npx turbo login. Then link your repo to enable the Remote Caching using npx turbo link. You will get a prompt to enable Remote Caching for the current repo. Enter Y for yes to enable Remote Caching. Next, select the team scope you'd like to connect to. Once completed, Turborepo will use Vercel Remote Caching to store the cache artifacts.