|
| 1 | +<img src="https://og.sznm.dev/api/generate?heading=nextarter-tailwind&text=Next.js+(App+Router)+template+with+TailwindCSS+and+TypeScript+setup.&template=color¢er=true&height=320" /> |
| 2 | + |
| 3 | +[](https://vercel.com/import/git?s=https://github.com/sozonome/nextarter-tailwind) [](https://app.netlify.com/start/deploy?repository=https://github.com/sozonome/nextarter-tailwind) |
| 4 | + |
| 5 | +[](https://stackblitz.com/github/sozonome/nextarter-tailwind) |
| 6 | + |
| 7 | +This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app), added with [**TailwindCSS**](https://tailwindcss.com) and [**TypeScript**](https://www.typescriptlang.org) setup. |
| 8 | +Start developing right away! |
| 9 | + |
| 10 | +## 🔋⚡ Super Battery Packed template |
| 11 | + |
| 12 | +- 🚀 **Next.js 13 (App Router)** - **React 18** |
| 13 | +- ⛓️ **TypeScript** |
| 14 | +- **TailwindCSS** v3 - with base shadcn/ui setup |
| 15 | + - recommended to extend with one of these: |
| 16 | + - [shadcn/ui](https://ui.shadcn.com/) |
| 17 | + - [tremor](https://www.tremor.so/) |
| 18 | + - [flowbite-react](https://www.flowbite-react.com/) |
| 19 | + - [daisyUI](https://daisyui.com/) |
| 20 | + - [Headless UI](https://headlessui.com/) |
| 21 | + - [NextUI v2](https://github.com/nextui-org/nextui/discussions/1035) |
| 22 | +- ✔️ **toolings** for linting, formatting, and conventions configured |
| 23 | + - `eslint`, `prettier`, `husky`, `lint-staged`, `commitlint`, `commitizen`, and `standard-version` |
| 24 | + - `pre-commit`, `pre-push`, `commit-msg`, `prepare-commit-msg` hook configured |
| 25 | +- 📱 **PWA-ready** - `next-pwa` configured, enabled by default, just disable it through `next.config.js` |
| 26 | +- 🔎 SEO optimization configured - with `next-seo` and `next-sitemap`. |
| 27 | + - you'll need to reconfigure or tinker with it to get it right according to your needs, but it's there if you need it. |
| 28 | +- 🎨 basic responsive layout configured - don't need it? just remove it 😃 |
| 29 | +- 🤖 **Automatic Dependency Update** with [Renovate](https://renovatebot.com/) |
| 30 | +- 🏎️ **Turbo** setup |
| 31 | + |
| 32 | +[](https://sonarcloud.io/dashboard?id=sozonome_nextarter-tailwind) [](https://sonarcloud.io/dashboard?id=sozonome_nextarter-tailwind) [](https://sonarcloud.io/dashboard?id=sozonome_nextarter-tailwind) [](https://sonarcloud.io/dashboard?id=sozonome_nextarter-tailwind) [](https://sonarcloud.io/dashboard?id=sozonome_nextarter-tailwind) |
| 33 | + |
| 34 | +## Getting Started |
| 35 | + |
| 36 | +You can either click `Use this template` button on this repository and clone the repo or directly from your terminal: |
| 37 | + |
| 38 | +```bash |
| 39 | +npx degit sozonome/nextarter-tailwind <APP_NAME> |
| 40 | +``` |
| 41 | + |
| 42 | +Install packages: |
| 43 | + |
| 44 | +```bash |
| 45 | +pnpm i |
| 46 | +``` |
| 47 | + |
| 48 | +Then, run the development server: |
| 49 | + |
| 50 | +```bash |
| 51 | +pnpm dev |
| 52 | +``` |
| 53 | + |
| 54 | +Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. |
| 55 | + |
| 56 | +You can start editing the page by modifying `src/pages/index.tsx`. The page auto-updates as you edit the file. |
| 57 | + |
| 58 | +## References |
| 59 | + |
| 60 | +- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. |
| 61 | +- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. |
| 62 | +- [TailwindCSS](https://tailwindcss.com) |
| 63 | +- [headless UI](https://headlessui.dev/) |
| 64 | +- [TypeScript](https://www.typescriptlang.org) |
0 commit comments