Next.js Starter

A beautifully designed, accessible, and customizable Next.js starter template built with Shadcn UI and Tailwind CSS.

Features

• Next.js 14 with App Router
• React 18
• TypeScript
• Tailwind CSS for styling
• Shadcn UI components
• Dark mode support with next-themes
• ESLint and Prettier for code linting and formatting
• Customizable theme using CSS variables
• Responsive design
• Accessibility-focused components

Getting Started

Prerequisites

• Node.js 20.18.0 or later
• npm

Installation

1. Clone the repository:

   git clone https://github.com/husniadil/nextjs-starter.git
   cd nextjs-starter
   

2. Install dependencies:

   npm install
   

3. Run the development server:

   npm run dev
   

4. Open http://localhost:3000 with your browser to see the result.

Scripts

• dev: Run the development server
• build: Build the production application
• start: Start the production server
• lint: Run ESLint
• lint:fix: Run ESLint and automatically fix issues
• preview: Build and start the production server
• typecheck: Run TypeScript type checking
• format:write: Format code using Prettier
• format:check: Check code formatting using Prettier

Project Structure

• app/: Next.js app directory containing pages and layouts
• components/: Reusable React components
• config/: Configuration files
• lib/: Utility functions and shared code
• public/: Static assets
• styles/: Global styles and Tailwind CSS configuration

Customization

• Update config/site.ts to change site metadata and navigation
• Modify tailwind.config.ts to customize the Tailwind CSS theme
• Adjust global styles in app/globals.css

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• Next.js
• Tailwind CSS
• Shadcn UI
• Radix UI

This project is based on the shadcn-ui/next-template repository. We appreciate their work in creating the original template that served as the foundation for this starter.