diff --git a/README.md b/README.md index ce3ebf2..8a89cb9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ +

- React-Project -

+ React-Projects +

@@ -13,12 +14,10 @@

- -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. +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. ## Table of Contents -- [Table of Contents](#table-of-contents) - [Getting Started](#getting-started) - [Contributing](#contributing) @@ -49,3 +48,41 @@ Follow these instructions to get the project up and running on your local machin ## Contributing Contributions are welcome! If you have any suggestions, improvements, or bug fixes, feel free to open an issue or submit a pull request. + +### How to Contribute + +1. **Create a folder for your project:** + - Navigate to the `/src/pages/` directory. + - Create a new folder named after your project. + +2. **Develop your project within the new folder.** + +3. **Add project details to `src/data/project.js`:** + ```js + { + id: {unique_id}, + name: {project_name}, + path: {project_path}, + tags: ['{tags}'] + } + // Example: + { + id: 19, + name: 'Weather App', + path: 'weather-app', + tags: ['project'] + } + ``` + +4. **Update routing in `app.jsx`:** + - Import your project file using React's `lazy` function: + ```js + const WeatherApp = lazy(() => import("@/pages/Weather-app/index")); + ``` + - Create a route for your project: + ```js + } /> + ``` + Ensure the `path` matches the one specified in `project.js`. + +Thank you for contributing!