This is a Next.js template set up with Tailwind CSS and the new Next.js App router. It is configured with the following:
- Eslint
- Tailwind CSS
- Typescript
- Prettier
- Lint-staged and Husky (for automatically checking code on commit)
Note that
@/
is used to refer to thesrc
directory in the project.
Eslint has been configured in this project to work with typescript using the
@typescript-eslint/eslint-plugin
and @typescript-eslint/parser
packages. It
also includes the Airbnb eslint config. Finally, the template is configured to
work with import aliases using the eslint-import-resolver-alias
package. You
can modify the array in settings["import/resolver"]["alias"]["map"]
in the
.eslintrc.json
and compilerOptions.path
object in the tsconfig.json
file
to add new aliases.
Note that this template is also configured to automatically run eslint
and
prettier
on commit (no automatic fixing) using husky
and lint-staged
.
You should also see the eslint rules specified in .eslintrc.json
, and modify
them as needed.
To use this template, do the following:
-
Clone the repository. Replace
<YOUR_PROJECT_NAME>
in the following command with your projct name or./
if you're in your project folder.git clone https://github.com/abdulramon-jemil/next-tailwind-template.git <YOUR_PROJECT_NAME>
-
Update the
LICENSE
file if needed (or modify it as needed):rm LICENSE
-
Restart the git history:
rm -rf .git git init git add . git commit -m "Initial commit"
-
Modify
package.json
andpackage-lock.json
to show your project's details:{ "name": "<YOUR_PROJECT_NAME>", "description": "<YOUR_PROJECT_DESCRIPTION>", "version": "<YOUR_PROJECT_VERSION>" }
-
Modify the project's README as needed or remove it:
rm README.md
-
Install the packages:
npm install
-
Run the prepare script:
npm run prepare
After these, you can start the Next.js development server:
npm run dev
Open http://localhost:3000 or (the necessary port) on
your browser to see the result. You can start editing the page by modifying
app/page.tsx
.
The packages included with this template might be outdated by the time you're using it, make sure to update packages as necessary.
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Tailwind CSS Documentation - learn about Tailwind CSS.
Found an issue somewhere in this template? Please create an issue to let me know. Your feedback and contributions are welcome!