Next.js + Tailwind CSS + HOC Auth + TypeScript Starter and Boilerplate with Realtime Chat & Notification
Next.js + Tailwind CSS + TypeScript starter packed with useful development features.
Made by Ryan Fernaldy
This repository is π battery packed with:
- β‘οΈ Next.js 14 with App Router
- βοΈ React 18
- β¨ TypeScript
- π¨ Tailwind CSS 3 β Configured with CSS Variables to extend the primary color
- π Pre-built Components β Components that will automatically adapt with your brand color, check here for the demo
- π 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.
- π Pagination β Built-in pagination table and card components using @tanstack/react-table.
- π‘ Socket.io β Websocket with authentication and realtime notifications
- βοΈ Chat β Implement a robust real-time chat feature using Socket.io, allowing seamless communication between users.
See the π feature details and changelog π for more.
You can also check all of the details and demos on my blog post:
-
Use this repository as template
Disclosure: by using this repository as a template, there will be an attribution on your repository.
I'll appreciate if you do, so this template can be known by others too π
-
Using
create-next-app
npx create-next-app -e https://github.com:ryanf10/ts-nextjs-tailwind-hoc-starter.git project-name
It is encouraged to use yarn so the husky hooks can work properly.
yarn install
This starter is using Backend Project (NestJS JWT Authentication and Authorization using MongoDB + Realtime Chat & Notifications using WebSocket).
You can start the server using this command:
yarn dev
Open http://localhost:3001 with your browser to see the result. You can start editing the page by modifying app/page.tsx
.
There are some things you need to change including title, urls, favicons, etc.
Find all comments with !STARTERCONF, then follow the guide.
Don't forget to change the package name in package.json
This starter is using conventional commits, it is mandatory to use it to commit changes.