smbddha / nextjs-boilerplate-simple

Simple boilerplate for Next.js, with TypeScript, SASS/SCSS, Styled Components, Jest, ESLint, Prettier, and deployed with Vercel.

Simple Next.js Boilerplate

Simple boilerplate for Next.js, with TypeScript, SASS/SCSS, Styled Components, Jest, ESLint, Prettier, and deployed to Vercel.

Also supports imports with absolute paths.

Demo at simple-nextjs-boilerplate.onbrn.com.

See more boilerplates at nextjs-boilerplates.onbrn.com.

Development

make install  # installs dependencies
make start  # starts the app
make pretty  # prettifies the code
make test  # runs linting and tests
make test/update  # runs tests, updating snapshots

Deployment

Just push a branch for a preview deployment, merge to main to deploy production.

TODOs

Here are some things you will likely want to change before "publishing" this, or after cloning it:

• theme-color in pages/_document.tsx
• Name, repository, author, and version in package.json
• Values in lib/constants.ts and styles/__variables.scss
• Values in .env.sample
• Title, description, and links in this README.md file