Skip to content

Commit

Permalink
docs(readme): update contirbuting instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
No0ne003 committed May 24, 2024
1 parent c5fd5fe commit 091839f
Showing 1 changed file with 42 additions and 5 deletions.
47 changes: 42 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@

<h1 align="center">
<b>React-Project</b>
</h3>
<b>React-Projects</b>
</h1>

<p align="center">
<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>
Expand All @@ -13,12 +14,10 @@
<a href="https://vitejs.dev/"><img src='https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white'></a>
</p>


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)

Expand Down Expand Up @@ -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
<Route path="weather-app" element={<WeatherApp />} />
```
Ensure the `path` matches the one specified in `project.js`.

Thank you for contributing!

0 comments on commit 091839f

Please sign in to comment.