snify / nextjs-pretty-boilerplate-tailwind

Boilerplate with everything needed to start developing with React, NextJS, TypeScript, SCSS with validations and checks. Tailwind is included as CSS framework. Unused CSS is removed on build.

NextJS-Pretty-Boilerplate-Tailwind

This is a Next.js project bootstrapped with [create-next-app] (https://github.com/vercel/next.js/tree/canary/packages/create-next-app).

...But with extra flavor 🎁

It contains:

• TypeScript support
• VSCode debug on client/server side Go to VSCode Debug panel (Ctrl+Shift+D on Windows/Linux, ⇧+⌘+D on macOS), select a launch configuration, then press F5 or select Debug: Start Debugging
• Type checking at runtime Works on hot-reload, change params on index.tsx#22 to try it
• Tailwind with automatic pruning on build (removes unused CSS (!))
• SASS support
• Project-wide automatic formatting with Prettier for TypeScript, JS, CSS files
• Project-wide automatic type checking/rule checking with ESLint
• BasePath resolving extensions (i.e. "components/mycomponent" instead of "./components/mycomponent")
• GitHub CI/CD which checks everything on new Pull Request
  

Few extra commands (i.e. yarn [command] or npm run [command]):

• format - formats all js, jsx, ts, tsx, json, md and saves them
• lint - linting checks
• lint:fix - automatic linting for all js, ts, tsx
• lint-scss - linting checks for scss using Stylelint
• lint-scss:fix - automatic linting for scss files
• types - type checking for ts/tsx files
  

Getting Started

First, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying src/pages/index.tsx. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in src/pages/api/hello.ts.

The src/pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.