Skip to content

Bot-Rakshit/bm_frontend

Repository files navigation

React + Vite + TypeScript Template (react-vite-ui)

License

A React + Vite template powered by shadcn/ui.

🎉 Features

  • React - A JavaScript library for building user interfaces.
  • Vite - A fast, opinionated frontend build tool.
  • TypeScript - A typed superset of JavaScript that compiles to plain JavaScript.
  • Tailwind CSS - A utility-first CSS framework.
  • Tailwind Prettier Plugin - A Prettier plugin for formatting Tailwind CSS classes.
  • ESLint - A pluggable linting utility for JavaScript and TypeScript.
  • PostCSS - A tool for transforming CSS with JavaScript.
  • Autoprefixer - A PostCSS plugin to parse CSS and add vendor prefixes.
  • shadcn/ui - Beautifully designed components that you can copy and paste into your apps.

⚙️ Prerequisites

Make sure you have the following installed on your development machine:

  • Node.js (version 16 or above)
  • pnpm (package manager)

🚀 Getting Started

Follow these steps to get started with the react-vite-ui template:

  1. Clone the repository:

    git clone https://github.com/dan5py/react-vite-ui.git
  2. Navigate to the project directory:

    cd react-vite-ui
  3. Install the dependencies:

    pnpm install
  4. Start the development server:

    pnpm dev

📜 Available Scripts

  • pnpm dev - Starts the development server.
  • pnpm build - Builds the production-ready code.
  • pnpm lint - Runs ESLint to analyze and lint the code.
  • pnpm preview - Starts the Vite development server in preview mode.

📂 Project Structure

The project structure follows a standard React application layout:

react-vite-ui/
  ├── node_modules/      # Project dependencies
  ├── public/            # Public assets
  ├── src/               # Application source code
  │   ├── components/    # React components
  │   │   └── ui/        # shadc/ui components
  │   ├── styles/        # CSS stylesheets
  │   ├── lib/           # Utility functions
  │   ├── App.tsx        # Application entry point
  │   └── index.tsx      # Main rendering file
  ├── .eslintrc.json     # ESLint configuration
  ├── index.html         # HTML entry point
  ├── postcss.config.js  # PostCSS configuration
  ├── tailwind.config.js # Tailwind CSS configuration
  ├── tsconfig.json      # TypeScript configuration
  └── vite.config.ts     # Vite configuration

📄 License

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

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages