Repository files navigation

This repository is 🔋 battery packed with:

• ⚡️ Next.js 14 with App Router
• ⚛️ React 18
• ✨ TypeScript
• 💨 Tailwind CSS 3 — Configured with CSS Variables to extend theprimary color
• 💎 Pre-built Components — Components that willautomatically 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 willauto 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 therelease-please workflow
• 👷 Github Actions — Lint your code on PR
• 🚘 Automatic Branch and Issue Autolink — Branch will be automatically created on issueassign, and auto linked on PR
• 🔥 Snippets — A collection of useful snippets
• 👀 Open Graph Helper Function — Awesome open graph generated usingog, fork it and deploy!
• 🗺 Site Map — Automatically generate sitemap.xml
• 📦 Expansion Pack — Easily install common libraries, additional components, and configs.

See the 👉feature details and changelog 👈 for more.

You can also check all of thedetails and demos on my blog post:

• One-stop Starter to Maximize Efficiency on Next.js & Tailwind CSS Projects

1. 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 😄

   

2. Usingcreate-next-app

   pnpm create next-app  -e https://github.com/theodorusclarence/ts-nextjs-tailwind-starter ts-pnpm

   If you still want to usepages directory (is not actively maintained) you can use this command

   npx create-next-app -e https://github.com/theodorusclarence/ts-nextjs-tailwind-starter/tree/pages-directory project-name

3. Usingdegit

   npx degit theodorusclarence/ts-nextjs-tailwind-starter YOUR_APP_NAME

4. Deploy to Vercel

   

It is encouraged to usepnpm so the husky hooks can work properly.

pnpm install

You can start the server using this command:

pnpm dev

Openhttp://localhost:3000 with your browser to see the result. You can start editing the page by modifyingsrc/pages/index.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 usingconventional commits, it is mandatory to use it to commit changes.

• theodorusclarence.com (Source)
• Notiolink (Source)
• NextJs + Materia UI + Typescript

Are you using this starter? Please add your page (and repo) to the end of the list via aPull Request. 😃

This starter is now equipped with anexpansion pack.

You can easily add expansion such as React Hook Form + Components, Storybook, and more just using a single command line.

Check out theexpansion pack repository for the commands

Due to App Router update, the expansion pack is currentlyoutdated. It will be updated in the future. You can still use them by copy and pasting the files.