Nextjs Materia Mui Typescript Hook Form Scaffold Boilerplate Starter
Theme by
Alexstack |Updated:
10 Aug 2024
|83 Stars
The scaffold & example for NextJs 15.x with ReactJs 19.x, React Hook Form, Material UI(MUI 6.x),Typescript and ESLint with simple next.js 15 example of NextJs API, React-hook-form with zod, fetch remote api, 404/500 error pages, MUI SSR usage.
Categories
Overview
The NextJs 13.x + MUI 5.x + React Hook Form + TypeScript Starter and Boilerplate is a comprehensive template for starting a new project using Next.js, Material UI, React Hook Form, and TypeScript. It comes with a set of battery-packed features and configurations to streamline the development process.
Features
- Next.js 13.x with App Router
- React 18.x
- TypeScript
- Material UI - Ready to use Material Design components
- React Hook Form - Performant, flexible, and extensible forms with easy-to-use validation
- Day.js - A modern day JavaScript Date Library
- Utils: getApiResponse - consoleLog
- Jest - Configured for unit testing
- Absolute Import and Path Alias - Import components using @/ prefix
- ESLint - Find and fix problems in your code, also will auto sort your imports
- Prettier - Format your code consistently
- Husky & Lint Staged - Run scripts on your staged files before they are committed
- Conventional Commit Lint - Make sure you & your teammates follow conventional commit
- Release Please - Generate your changelog by activating the release-please workflow
- Github Actions - Lint your code on PR
- Automatic Branch and Issue Autolink - Branch will be automatically created on issue assign, and auto-linked on PR
- Snippets - A collection of useful snippets
- Open Graph Helper Function - Awesome open graph generated using og, fork it and deploy!
- Site Map - Automatically generate sitemap.xml
- Expansion Pack - Easily install common libraries, additional components, and configs
Installation
To get started with the template, follow these steps:
- Clone this template using one of the following methods:
- Test locally: Using create-next-app
- Test online: Deploy to Vercel by one click
- Deploy with Vercel
- Install dependencies. It is recommended to use yarn for proper functioning of husky hooks.
- Run the development server using the command provided. Open http://localhost:3000 to view the result in your browser.
- Customize the default settings such as title, URLs, favicons, etc. by following the instructions marked with
!STARTERCONF comments. Change the package name in package.json as well. - Follow the Commit Message Convention (conventional commits) for committing changes.
Summary
The NextJs 13.x + MUI 5.x + React Hook Form + TypeScript Starter and Boilerplate is a powerful and highly customizable template for quickly setting up a project using Next.js, Material UI, React Hook Form, and TypeScript. It offers a wide range of features and configurations to enhance the development experience. With clear installation instructions and customization guides, it provides a solid foundation for building modern web applications. Whether you prefer Tailwind CSS or not, there’s an option available to suit your needs.