Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/utsavdotpro/starter-nextjs-tailwind-ts
A starter template for NextJS with Tailwind in TypeScript
https://github.com/utsavdotpro/starter-nextjs-tailwind-ts
nextjs nextjs-starter starter-template tailwind typescript
Last synced: 14 days ago
JSON representation
A starter template for NextJS with Tailwind in TypeScript
- Host: GitHub
- URL: https://github.com/utsavdotpro/starter-nextjs-tailwind-ts
- Owner: utsavdotpro
- Created: 2022-01-11T15:26:19.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-22T10:43:03.000Z (over 1 year ago)
- Last Synced: 2023-07-22T11:47:28.503Z (over 1 year ago)
- Topics: nextjs, nextjs-starter, starter-template, tailwind, typescript
- Language: TypeScript
- Homepage:
- Size: 170 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[
](https://githubbox.com/utsavdotpro/starter-nextjs-tailwind-ts)
# NextJS with Tailwind in TypeScript
A starter template for NextJS with Tailwind in TypeScript with an opinionated [modular project structure](#project-structure).
> Uses NextJS's latest [`app` directory](https://nextjs.org/docs/app/building-your-application/routing)
### Technologies
[](https://nextjs.org/)
[](https://tailwindcss.com)
[](https://react.dev/)
[](https://typescriptlang.org)
---
## How to Reuse Locally?
Use `degit` to download the repository locally.
> **❓ What is [degit](https://github.com/Rich-Harris/degit)?**
> degit downloads a copy of git repository with downloading its entire git history.
Install degit globally.
````bash
npm install -g degit
````
Download the latest version
````bash
degit utsavdotpro/starter-nextjs-tailwind-ts
````
---
## Getting Started
Install dependencies
````bash
yarn install
````
Run the development build
````bash
yarn dev
````
Run the production build
````bash
yarn build
yarn start
````
## Project Structure
```
project
|-- public ℹ️ keep your static resource files
|-- src
| |-- app ℹ️ NextJS app directory
| | |-- api ℹ️ NextJS api directory
| |-- common
| | |-- components
| | | |-- elements ℹ️ keep your state-less components
| | | | ℹ️ keep your state-full components
| | |-- hoc
| | |-- hooks
| | |-- layouts
| |-- core
| | |-- config ℹ️ keep your configuration files
| | |-- constants
| | |-- services
| | |-- types
| | |-- utils
| |-- lib
| |-- modules
| |-- styles
```
## Deployment
The easiest way to deploy your Next.js app is to use the [Vercel](https://vercel.com/) platform from the creators of Next.js.
Check out the Next.js deployment [docs](https://nextjs.org/docs/deployment) for more details.