-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: Update README with project setup instructions
- Loading branch information
Showing
1 changed file
with
41 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,44 @@ | ||
# React + Vite | ||
# React-Projects | ||
|
||
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. | ||
Welcome to the React-Projects repository! This project is a collection of React applications bundled together using Vite, styled with Tailwind CSS, and enhanced with UI components from ui.shadcn. It's a powerful and flexible setup that allows you to manage and deploy multiple React projects within a single application. | ||
|
||
Currently, two official plugins are available: | ||
## Table of Contents | ||
|
||
- [React-Projects](#react-projects) | ||
- [Table of Contents](#table-of-contents) | ||
- [Getting Started](#getting-started) | ||
- [Technologies Used](#technologies-used) | ||
- [Contributing](#contributing) | ||
|
||
## Getting Started | ||
|
||
Follow these instructions to get the project up and running on your local machine. | ||
|
||
1. **Clone the repository:** | ||
|
||
```bash | ||
git clone https://github.com/No0ne003/React-Project.git | ||
``` | ||
|
||
2. **Install dependencies:** | ||
|
||
```bash | ||
npm install | ||
``` | ||
|
||
3. **Run the development server:** | ||
|
||
```bash | ||
npm run dev | ||
``` | ||
|
||
This will start the development server, and you can access the application at `http://localhost:3000`. | ||
|
||
## Technologies Used | ||
|
||
[![Tailwind](https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white)](https://tailwindcss.com) [![react](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)](https://reactjs.org/) [![Vite](https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white)](https://vitejs.dev/) | ||
|
||
## Contributing | ||
|
||
Contributions are welcome! If you have any suggestions, improvements, or bug fixes, feel free to open an issue or submit a pull request. | ||
|
||
- [@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 |