Skip to content

Commit

Permalink
feature: Readme corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
praptisharma28 committed Jan 14, 2024
1 parent 6c105d1 commit beee247
Showing 1 changed file with 54 additions and 66 deletions.
120 changes: 54 additions & 66 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,107 +1,83 @@
![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB)
[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![All Contributors](https://img.shields.io/badge/all_contributors-10-orange.svg?style=flat-square)](#contributors-)

![Vite](https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white)
![Vercel](https://img.shields.io/badge/vercel-%23000000.svg?style=for-the-badge&logo=vercel&logoColor=white)
![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)
<a href="https://github.com/WikiPortal/DoodleCollab" alt="GitHub contributors">

---

<h1 align="center">DoodleCollab</h1>
<div align="center">

![DoodleCollab](https://github.com/WikiPortal/DoodleCollab/blob/main/src/assets/ReadMe/doodleCollab.gif)

</div>
<h4 align="center">Your Ultimate Whiteboard and Sharing Solution</h4>


<div align="center">

</div>

## What is DoodleCollab ? ๐Ÿค”

DoodleCollab is a cutting-edge application designed to transform the way we collaborate, offering an unparalleled whiteboard and sharing experience. Developed using the powerful ReactJS framework, our app seamlessly combines intuitive design with advanced functionalities to enhance your collaborative efforts.

## Willing to help ? ๐Ÿ‘ฉ๐Ÿปโ€๐Ÿ’ป

*A beginner to Open Source, Web Development ?*
<br/>

This might be the debut repo for you, you can contribute to this repo, solve the issues, raise one and learn more about web as well as get started with Open Source and contributing to projects. Remember, we believe in *Quality*.

---

## Hello Contributors ๐Ÿ‘‹๐Ÿป

---

## Setup Steps

Follow these steps to set up the DoodleCollab app locally:

1. *Clone the repository:*
bash
git clone https://github.com/WikiPortal/DoodleCollab.git


2. *Navigate to the project directory:*
bash
cd DoodleCollab


3. *Install dependencies:*
bash
npm install


4. *If vite is not installed:*
bash
npm i vite
npm install --legacy-peer-deps


5. *Start the development server:*
bash
npm run start

## Related image (Project under progress) ๐Ÿšง

6. *Open your browser and visit [http://localhost:5173](http://localhost:5173)*
![Screenshot](https://i.postimg.cc/65rBwdy5/Screenshot.png)

---

- *You can also have a look at the [Contributing Guidelines](CONTRIBUTING.md) for proper contributions*
- *and at the [Setup Guidelines](rules/Setup.md) to setup the react app locally*
- *also at the [Workflow Guidelines](workflow.md) to see the workflow of the project.*

## Technologies used ๐Ÿ’ป

![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB)
![React Router](https://img.shields.io/badge/React_Router-CA4245?style=for-the-badge&logo=react-router&logoColor=white)
![Vite](https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white)
![CSS3](https://img.shields.io/badge/css3-%231572B6.svg?style=for-the-badge&logo=css3&logoColor=white)
![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)
![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white)
![MUI](https://img.shields.io/badge/MUI-%23563D7C.svg?style=for-the-badge&logo=MUI&logoColor=white)
![verce](https://img.shields.io/badge/vercel-%23000000.svg?style=for-the-badge&logo=verce&logoColor=#00C7B7)

---
## Willing to help ? ๐Ÿ‘ฉ๐Ÿปโ€๐Ÿ’ป

## Related image (Project under progress) ๐Ÿšง
*A beginner to Open Source, Web Development ?*

![Screenshot](https://i.postimg.cc/65rBwdy5/Screenshot.png)
This might be the debut repo for you, you can contribute to this repo, solve the issues, raise one and learn more about web as well as get started with Open Source and contributing to projects. Remember, we believe in *Quality*.

---
## Setup Steps ๐Ÿ”

## ๐Ÿ™ Support
Follow these steps to set up the DoodleCollab app locally:

This project needs a โญ from you. Don't forget to leave a star โญ
1. **Clone the repository:**
```bash
git clone https://github.com/WikiPortal/DoodleCollab.git
```

---
2. **Navigate to the project directory:**
```bash
cd DoodleCollab
```

## Happy Contributions !!
3. **Install dependencies:**
```bash
npm install
```

4. **If vite is not installed:**
```bash
npm i vite
npm install --legacy-peer-deps
```

5. **Start the development server:**
```bash
npm run start
```

6. **Open your browser and visit [http://localhost:5173](http://localhost:5173):**
<br>

You can execute these commands one by one in a bash environment.
- *You can also have a look at the [Contributing Guidelines](CONTRIBUTING.md) for proper contributions*
- *Have a look at the [Setup Guidelines](rules/Setup.md) to setup the react app locally*
- *Click here [Workflow Guidelines](workflow.md) to see the workflow of the project.*

---
## Contributors โœจ

Thanks goes to these wonderful people:
Expand Down Expand Up @@ -132,4 +108,16 @@ Thanks goes to these wonderful people:
</tr>
</tfoot>
</table>
Contributions of any kind are welcome!
Contributions of any kind are welcome!๐Ÿค—

## License ๐Ÿ‘ฎ

DoodleCollab is Licensed under the <a href="/LICENSE">Apache License</a>. Please go through the License at least once before contributing.

## Support ๐Ÿ™

This project needs a โญ from you. Don't forget to leave a star โญ
## Happy Contributions ! ๐Ÿš€
---

0 comments on commit beee247

Please sign in to comment.