|
| 1 | +<p align="center"> |
| 2 | + <img src="https://user-images.githubusercontent.com/26466516/107675802-36216b80-6c77-11eb-8db1-4d3407dc53d9.png" alt="Next.js and TypeScript"> |
| 3 | +</p> |
| 4 | + |
| 5 | +<p align="center"> |
| 6 | + <img src="https://img.shields.io/static/v1?label=PRs&message=welcome&style=for-the-badge&color=24B36B&labelColor=000000" alt="PRs welcome!" /> |
| 7 | + |
| 8 | + <img alt="License" src="https://img.shields.io/github/license/chhpt/typescript-nextjs-starter?style=for-the-badge&color=24B36B&labelColor=000000"> |
| 9 | + |
| 10 | + <a href="https://twitter.com/intent/follow?screen_name=cwuyiqing"> |
| 11 | + <img src="https://img.shields.io/twitter/follow/cwuyiqing?style=for-the-badge&color=24B36B&labelColor=000000" alt="Follow @chhpt" /> |
| 12 | + </a> |
| 13 | +</p> |
| 14 | + |
| 15 | +<br> |
| 16 | + |
| 17 | +A full-featured Next.js starter that includes all you need to build amazing projects 🔥. Fork and customize from [jpedroschmitz](https://github.com/jpedroschmitz/typescript-nextjs-starter) |
| 18 | + |
| 19 | +- 🚀 **Next.js 15 App Router & React 18** |
| 20 | +- ⚙️ **Tailwind CSS 3** - A utility-first CSS framework |
| 21 | +- 🍓 **Styled Components** - Styling React component |
| 22 | +- 📏 **ESLint** — Pluggable JavaScript linter |
| 23 | +- 💖 **Prettier** - Opinionated Code Formatter |
| 24 | +- 🐶 **Husky** — Use git hooks with ease |
| 25 | +- 🚫 **lint-staged** - Run linters against staged git files |
| 26 | +- 😁 **shadcn** - Beautifully designed components that you can copy and paste into your apps. |
| 27 | +- 🗂 **Absolute import** - Import folders and files using the `@` prefix |
| 28 | +- 🤩 **Vercel Serverless/Edge Functions** - Serverless/Edge functions for Next.js |
| 29 | + |
| 30 | +## 🚀 Getting started |
| 31 | + |
| 32 | +The best way to start with this template is using `create-next-app`. |
| 33 | + |
| 34 | +``` |
| 35 | +npx create-next-app ts-next -e https://github.com/chhpt/nextjs-starter |
| 36 | +``` |
| 37 | + |
| 38 | +or |
| 39 | + |
| 40 | +``` |
| 41 | +pnpm create next-app ts-next -e https://github.com/chhpt/nextjs-starter |
| 42 | +``` |
| 43 | + |
| 44 | +If you prefer you can clone this repository and run the following commands inside the project folder: |
| 45 | + |
| 46 | +1. `pnpm install` or `npm install`; |
| 47 | +2. `pnpm dev`; |
| 48 | + |
| 49 | +To view the project open `http://localhost:3000`. |
| 50 | + |
| 51 | +## 🤝 Contributing |
| 52 | + |
| 53 | +1. Fork this repository; |
| 54 | +2. Create your branch: `git checkout -b my-new-feature`; |
| 55 | +3. Commit your changes: `git commit -m 'Add some feature'`; |
| 56 | +4. Push to the branch: `git push origin my-new-feature`. |
| 57 | + |
| 58 | +**After your pull request is merged**, you can safely delete your branch. |
| 59 | + |
| 60 | +## 📝 License |
| 61 | + |
| 62 | +This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for more information. |
| 63 | + |
| 64 | +--- |
| 65 | + |
| 66 | +Made with ♥ by Clare Chang |
0 commit comments