Skip to main content

Next.js

We are using NextJs which started from this boilerplate. Which includes these features.

  • ๐Ÿ”ฅ Next.js for Static Site Generator
  • ๐ŸŽจ Integrate with Tailwind CSS
  • ๐Ÿ’… PostCSS for processing Tailwind CSS and integrated to styled-jsx
  • ๐ŸŽ‰ Type checking TypeScript
  • โœ… Strict Mode for TypeScript and React 17
  • โœ๏ธ Linter with ESLint (default NextJS, NextJS Core Web Vitals, Tailwind CSS and Airbnb configuration)
  • ๐Ÿ’ก Absolute Imports
  • ๐Ÿ›  Code Formatter with Prettier
  • ๐ŸฆŠ Husky for Git Hooks
  • ๐Ÿšซ Lint-staged for running linters on Git staged files
  • ๐Ÿ—‚ VSCode configuration: Debug, Settings, Tasks and extension for PostCSS, ESLint, Prettier, TypeScript
  • ๐Ÿค– SEO metadata, JSON-LD and Open Graph tags with Next SEO
  • โš™๏ธ Bundler Analyzer
  • ๐Ÿ–ฑ๏ธ One click deployment with Vercel or Netlify (or manual deployment to any hosting services)
  • ๐ŸŒˆ Include a FREE minimalist theme
  • ๐Ÿ’ฏ Maximize lighthouse score

Requirementsโ€‹

  • Node.js 16+ and npm

Folder Structureโ€‹

rentreef # root directory of your site
โ”œโ”€โ”€ ๐Ÿ“ main # next.js & storybook
โ”‚ โ”œโ”€โ”€ package.json
โ”‚ โ”œโ”€โ”€ next.config.js # next.js config
โ”‚ โ”œโ”€โ”€ node_modules
โ”‚ โ”œโ”€โ”€ readme.md
โ”‚ โ”œโ”€โ”€ TailwindUIExamples
โ”‚ โ”œโ”€โ”€ public
โ”‚ โ”œโ”€โ”€ .env.local # env variables
โ”‚ โ”œโ”€โ”€ .husky
โ”‚ โ”œโ”€โ”€ .next
โ”‚ โ”œโ”€โ”€ .storybook
โ”‚ โ”œโ”€โ”€ .gitignore
โ”‚ โ””โ”€โ”€ ๐Ÿ“ src
โ”‚ โ”œโ”€โ”€ ๐Ÿ“ components # atomic design
โ”‚ โ”‚ โ”œโ”€โ”€ atoms
โ”‚ โ”‚ โ”œโ”€โ”€ molecules
โ”‚ โ”‚ โ”œโ”€โ”€ navigation
โ”‚ โ”‚ โ”œโ”€โ”€ organisms
โ”‚ โ”‚ โ””โ”€โ”€ home
โ”‚ โ”œโ”€โ”€ interfaces
โ”‚ โ”œโ”€โ”€ layout
โ”‚ โ”œโ”€โ”€ pages
โ”‚ โ”œโ”€โ”€ stories # storybook
โ”‚ โ”œโ”€โ”€ styles
โ”‚ โ””โ”€โ”€ templates
โ””โ”€โ”€ ๐Ÿ“ app-docs # docs