Skip to content

Commit 42c60f5

Browse files
committed
update contirbuting on README
1 parent c5fd5fe commit 42c60f5

File tree

1 file changed

+42
-5
lines changed

1 file changed

+42
-5
lines changed

README.md

Lines changed: 42 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1+
12
<h1 align="center">
2-
<b>React-Project</b>
3-
</h3>
3+
<b>React-Projects</b>
4+
</h1>
45

56
<p align="center">
67
<a href="https://github.com/No0ne003/React-Project/stargazers"><img src="https://img.shields.io/github/stars/No0ne003/React-Project?colorA=363a4f&colorB=b7bdf8&style=for-the-badge"></a>
@@ -13,12 +14,10 @@
1314
<a href="https://vitejs.dev/"><img src='https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white'></a>
1415
</p>
1516

16-
17-
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.
17+
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.
1818

1919
## Table of Contents
2020

21-
- [Table of Contents](#table-of-contents)
2221
- [Getting Started](#getting-started)
2322
- [Contributing](#contributing)
2423

@@ -49,3 +48,41 @@ Follow these instructions to get the project up and running on your local machin
4948
## Contributing
5049

5150
Contributions are welcome! If you have any suggestions, improvements, or bug fixes, feel free to open an issue or submit a pull request.
51+
52+
### How to Contribute
53+
54+
1. **Create a folder for your project:**
55+
- Navigate to the `/src/pages/` directory.
56+
- Create a new folder named after your project.
57+
58+
2. **Develop your project within the new folder.**
59+
60+
3. **Add project details to `src/data/project.js`:**
61+
```js
62+
{
63+
id: {unique_id},
64+
name: {project_name},
65+
path: {project_path},
66+
tags: ['{tags}']
67+
}
68+
// Example:
69+
{
70+
id: 19,
71+
name: 'Weather App',
72+
path: 'weather-app',
73+
tags: ['project']
74+
}
75+
```
76+
77+
4. **Update routing in `app.jsx`:**
78+
- Import your project file using React's `lazy` function:
79+
```js
80+
const WeatherApp = lazy(() => import("@/pages/Weather-app/index"));
81+
```
82+
- Create a route for your project:
83+
```js
84+
<Route path="weather-app" element={<WeatherApp />} />
85+
```
86+
Ensure the `path` matches the one specified in `project.js`.
87+
88+
Thank you for contributing!

0 commit comments

Comments
 (0)