Git Product home page Git Product logo

boiler's Introduction

Next.js + Tailwind CSS + shadcn/ui Boilerplate

This is a boilerplate project for Next.js with Tailwind CSS and shadcn/ui integration.

Features

  • Next.js - React framework for building server-side rendered and static websites
  • TypeScript - Typed superset of JavaScript
  • Tailwind CSS - Utility-first CSS framework
  • shadcn/ui - Re-usable components built with Radix UI and Tailwind CSS

Getting Started

Prerequisites

  • Node.js 14.6.0 or newer
  • pnpm (recommended) or npm

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/nextjs-tailwind-shadcn-boilerplate.git
cd nextjs-tailwind-shadcn-boilerplate
  1. Install the dependencies:
pnpm install

Development

To start the development server:

pnpm dev

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

Build

To build the application for production:

pnpm build

Start

To start the production server:

pnpm start

Project Structure

nextjs-tailwind-shadcn-boilerplate/
├── src/
│   ├── components/
│   ├── pages/
│   │   ├── _app.tsx
│   │   └── index.tsx
│   └── styles/
│       └── globals.css
├── public/
├── next.config.js
├── package.json
├── postcss.config.js
├── README.md
├── tailwind.config.js
└── tsconfig.json

Adding shadcn/ui Components

To add shadcn/ui components, use the shadcn/ui CLI:

pnpm dlx shadcn-ui@latest add button

Replace button with the name of the component you want to add.

Customization

  • Modify tailwind.config.js to customize your design tokens and add new utility classes.
  • Update src/styles/globals.css to add your own custom styles.
  • Create new components in the src/components/ directory.
  • Add new pages in the src/pages/ directory.

Learn More

To learn more about the technologies used in this boilerplate, take a look at the following resources:

License

This project is open source and available under the MIT License.

boiler's People

Contributors

giulioco avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.