https://github.com/srijanshetty/nextjs-ts-tailwind-template
A template to get started with next, typescript and tailwind css
https://github.com/srijanshetty/nextjs-ts-tailwind-template
css eslint nextjs prettier react tailwind template typescript
Last synced: about 2 months ago
JSON representation
A template to get started with next, typescript and tailwind css
- Host: GitHub
- URL: https://github.com/srijanshetty/nextjs-ts-tailwind-template
- Owner: srijanshetty
- Created: 2022-02-17T08:20:32.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-09-10T08:26:32.000Z (over 2 years ago)
- Last Synced: 2025-01-17T19:51:06.876Z (3 months ago)
- Topics: css, eslint, nextjs, prettier, react, tailwind, template, typescript
- Language: TypeScript
- Homepage:
- Size: 329 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Next.js TailwindCSS Typescript Starter
This is a [Next.js](https://nextjs.org/) 12.x, [TailwindCSS](https://tailwindcss.com/) 3.x, and [TypeScript](https://www.typescriptlang.org/docs/home.html) 4.x starter template
For more details, see my blog post. [Nextjs TailwindCSS Typescript Starter](https://dev.to/vuongddang/nextjs-tailwindcss-typescript-starter-1c2m)
## How to use this template
Here're a few ways to create your new project using this template.
### Using `create-next-app`
Create a new next.js app from the template using [create-next-app](https://github.com/vercel/next.js/tree/canary/packages/create-next-app)
```
npx create-next-app --example "https://github.com/vuongddang/nextjs-tailwindcss-typescript-starter/tree/main"
# or
yarn create next-app --example "https://github.com/vuongddang/nextjs-tailwindcss-typescript-starter/tree/main"
```
### Create new repository from github [template](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template)
You can generate a new repository with the same directory structure and files by click `Use this template` button in the upper right or [click here](https://github.com/vuongddang/nextjs-tailwindcss-typescript-starter/generate).
## Getting Started
Install dependencies:
```bash
npm install
# or
yarn install
```
Run the development server:
```bash
npm run dev
# or
yarn dev
```
Open [http://localhost:3001](http://localhost:3001) with your browser to see the result.
You can start editing the page by modifying `src/pages/index.js`. The page auto-updates as you edit the file.
## Deploy on Vercel
Once you have the project running locally you can [import](https://vercel.com/import/git) your project to Vercel and get it up and running in a few clicks.
Other option is to click on the button below to create a new repository that look exactly like this one, and sets it up and running on Vercel.
[](https://vercel.com/import/project?template=https://github.com/vuongddang/nextjs-tailwindcss-typescript-starter/tree/main)
Check out [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.