37 lines
1.1 KiB
Markdown
37 lines
1.1 KiB
Markdown
|
# [next-template](https://github.com/tommyxchow/next-template)
|
||
|
|
|
||
|
|
A tailored Next.js template project for getting started quickly.
|
||
|
|
|
||
|
|
## Why
|
||
|
|
|
||
|
|
I spend a bit of tme repeating the same steps when setting up Next.js projects. This template builds upon [`create-next-app`](https://nextjs.org/docs/pages/api-reference/create-next-app) to include my essential packages, configurations, linting rules, and more by default.
|
||
|
|
|
||
|
|
## Features
|
||
|
|
|
||
|
|
- Precofigured packages
|
||
|
|
- Preconfigured ESLint and Prettier rules
|
||
|
|
- Default boilerplate removed
|
||
|
|
- Dark mode support
|
||
|
|
- Formatted README
|
||
|
|
|
||
|
|
## Stack
|
||
|
|
|
||
|
|
- [Next.js](https://nextjs.org/)
|
||
|
|
- [next-themes](https://github.com/pacocoursey/next-themes)
|
||
|
|
- [Tailwind CSS](https://tailwindcss.com/) (with [Forms](https://github.com/tailwindlabs/tailwindcss-forms) and [Typography](https://tailwindcss.com/docs/typography-plugin) plugins)
|
||
|
|
- [tailwind-merge](https://github.com/dcastil/tailwind-merge)
|
||
|
|
|
||
|
|
## Setup
|
||
|
|
|
||
|
|
Setup instructions are here if necessary. Usually adding environment variables like so:
|
||
|
|
|
||
|
|
```plaintext
|
||
|
|
# .env.local
|
||
|
|
CLIENT_ID=
|
||
|
|
SECRET=
|
||
|
|
```
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
next-template is licensed under [MIT](LICENSE).
|