Skip to content

magicspon/nextjs-starter

Repository files navigation

NextJS Typescript/TailwindCSS starter kit

Features

  • Next JS
  • Tailwind
  • Typescript
  • graphql-codegen/typescript
  • CraftCMS Helpers
  • @svgr/webpack
  • Hygen generator
  • Husky
  • Jest
  • eslint
  • prettier
  • stylelint

With Docker:

  1. Install Docker on your machine.
  2. Build your container: docker build -t nextjs-docker ..
  3. Run your container: docker run -p 3000:3000 nextjs-docker.

Installation

  • To setup the frontend tooling and nextjs run yarn install or npm install

Commands

  • yarn dev : starts the app package nextjs server
  • yarn test : run all of the tests
  • yarn build : build the next js app
  • yarn start : start the production site
  • yarn lint : lint the frontend code
  • yarn storybook : runs the ui package storybook server
  • yarn release : tag a release, update changelog

Code scaffold

  • yarn new:component : create a new component
  • yarn new:page : create a new nextjs page
  • yarn new:context : create a new context provider

TypeScript GraphQL-Request

See https://www.graphql-code-generator.com/docs/plugins/typescript-graphql-request for docs