Skip to content

weber-stephen/nextjs-typescript-tailwind-starter

Repository files navigation

nextjs-typescript-tailwind-starter

Starter codebase for Nextjs using Typescript and Tailwind Components

Features

Developer experience first:

  • 🔥 Next.js for Static Site Generator
  • 🎨 Uses Tailwind CSS and Tailwind Components
  • 🎉 Type checking TypeScript
  • 🤖 SEO metadata, JSON-LD and Open Graph tags with Next SEO

Built-in feature from Next.js:

  • ☕ Minify HTML & CSS
  • 💨 Live reload
  • ✅ Cache busting

Included Components

  • Navbar
  • Banner
  • Features
  • Footer
  • Layout

Getting Started

Requirements

  • Node.js and npm

Getting started

  • Clone the repo
  • Install dependencies by running the command in the repo
npm install
  • Then, you can run locally in development mode with live reload:
npm run dev

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Directory Structure

.
├── README.md            # README file
├── next.config.js       # Next JS configuration
├── public               # Public folder
├── components           # Components
├── layout               # Atomic layout component
├── pages                # Next JS pages
├── styles               # PostCSS style folder with Tailwind
├── utils                # Utility folder
├── tailwind.config.js   # Tailwind CSS configuration
└── tsconfig.json        # TypeScript configuration

About

Starter codebase for Nextjs using Typescript and Tailwind Components

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published