/nextjs-boilerplate-simple

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

Primary LanguageTypeScript

Simple Next.js Boilerplate

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

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
make deploy  # deploys to simple-nextjs-boilerplate.onbrn.com (requires `serverless` to be installed globally)

NOTE: If you're looking for the previous version which deployed to Vercel, this was the latest commit with it.

TODOs

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

  • Analytics code (usefathom.com) and theme-color in pages/_document.tsx
  • Name, repository, author, and version in package.json
  • Values in lib/constants.ts and styles/__variables.scss
  • Service name, domain, and env values in serverless.yml
  • Values in .env.sample
  • Title, description, and links in this README.md file