React.shadcn.JS-Template

Welcome to the React.shadcn.JS-Template! This template is a robust starting point for building modern web applications using Vite and React with ShadcnUI, a design system for creating beautiful and consistent UIs.

Table of Contents

• Overview
  • Why This Template?
  • Technologies Used
  • Features
• Getting Started
  • Prerequisites
  • Installation
  • Running the Development Server
  • Building for Production
  • Linting and Formatting
• Project Structure
• Contributing
• Contact
• Acknowledgments

Overview

Why This Template?

This template is designed to kickstart your project development with modern technologies and design practices. It integrates React, Vite, Tailwind CSS, and ShadcnUI to help you build aesthetically pleasing and performant web applications with ease.

This template is a work in progress and will continue to evolve. We encourage you to suggest improvements by forking this repo, creating a pull request, or opening an issue. Your contributions are greatly appreciated!

Technologies Used

Features

• React: A powerful JavaScript library for building user interfaces.
• Vite: A next-generation frontend tooling. It's fast and efficient, perfect for modern web development.
• Tailwind CSS: A utility-first CSS framework for rapid UI development.
• ShadcnUI: A design system that provides components and utilities for creating consistent and elegant UIs.
• JavaScript: The core programming language for web development.
• PostCSS: A tool for transforming CSS with JavaScript plugins.
• ESLint: Code linting to maintain consistent code quality.
• Prettier: Code formatting to ensure a consistent code style.

Getting Started

Prerequisites

• Node.js (>= 20.0.0)
• npm (>= 10.0.0) or yarn (>= 1.22.0)

Installation

1. Clone the repository:

   git clone https://github.com/RanitManik/React.shadcn.JS-Template.git
   cd React.shadcn.JS-Template

2. Install dependencies:

   npm install

   or

   yarn install

Running the Development Server

To start the development server, run:

npm run dev

or

yarn dev

Open your browser and navigate to http://localhost:5173 to see the application in action.

Building for Production

To build the application for production, run:

npm run build

or

yarn build

The built files will be located in the dist directory.

Linting and Formatting

To lint your code, run:

npm run lint

or

yarn lint

To format your code, run:

npm run format

or

yarn format

Project Structure

The project structure is as follows:

├── components.json # Component metadata
├── index.html # HTML template
├── LICENSE # License information
├── package.json # Project dependencies and scripts
├── package-lock.json # Lock file for dependencies
├── postcss.config.js # PostCSS configuration
├── public # Static assets
│ └── vite.svg # Vite logo
├── README.md # Project documentation
├── src # Main source code
│ ├── App.jsx # Main application component
│ ├── components # All components
│ │ └── ui # Reusable ShadcnUI components
│ │     └── button.jsx # Shadcn Button component
│ ├── index.css # Global styles
│ ├── lib # Utility functions
│ │ └── utils.js # Utility functions
│ └── main.jsx # Entry point for React application
├── tailwind.config.js # Tailwind CSS configuration
├── tsconfig.json # TypeScript configuration
├── tsconfig.node.json # TypeScript configuration for Node.js
└── vite.config.js # Vite configuration file

Contributing

We welcome contributions to enhance the React.shadcn.JS-Template project. To contribute:

1. Fork the repository.

2. Create a new branch for your feature or bug fix:

   git checkout -b feature-name

3. Make your changes and commit them with clear and descriptive messages.

4. Push your changes to your fork:

   git push origin feature-name

5. Create a pull request to the main repository, detailing the changes and enhancements you have made.

Contact

• LinkedIn: Ranit Manik
• GitHub: RanitManik
• Email: ranitmanik.dev@gmail.com

Feel free to reach out if you have questions or just want to chat about web adventures!

Acknowledgments

• Markdown Badges
• shields.io Badges
• Skill Icons

---

Thank you for using the React.shadcn.JS-Template! Happy coding! 🚀