Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 33 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,36 @@
# React + Vite
# React Components Library

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
This project is a comprehensive library of reusable React components designed to streamline the development process. It includes a variety of components such as buttons, cards, modals, dropdowns, and more, all built with accessibility and performance in mind. The components are organized into categories for easy navigation and usage.

Currently, two official plugins are available:
## Getting Started

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
To get started with this project, follow these steps:

1. **Clone the repository**:
```bash
git clone <repository-url>
cd react-components
```

2. **Install dependencies**:
Before running the project, ensure you have Node.js installed. Then, run:
```bash
npm install
```
If you encounter any high vulnerabilities during installation, run:
```bash
npm audit fix
npm install
```
This is often due to outdated packages in the `package-lock.json`. By running `npm install`, a new `package-lock.json` will be generated with the latest versions of the dependencies.

3. **Run the development server**:
After installing the dependencies, start the development server with:
```bash
npm run dev
```
This will launch the application in your default web browser.

## Contributing

Contributions are welcome! Please open an issue or submit a pull request for any enhancements or bug fixes. Make sure to follow the project's coding standards and guidelines.
Loading