-
Notifications
You must be signed in to change notification settings - Fork 51
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #51 from praptisharma28/main
feature : readme and workflow.md updated
- Loading branch information
Showing
4 changed files
with
345 additions
and
23 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 |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| { | ||
| "projectName": "DoodleCollab", | ||
| "projectOwner": "WikiPortal", | ||
| "repoType": "github", | ||
| "repoHost": "https://github.com", | ||
| "files": ["README.md"], | ||
| "imageSize": 100, | ||
| "commit": true, | ||
| "commitConvention": "gitmoji", | ||
| "contributors": [ | ||
| { | ||
| "login": "AaadityaG", | ||
| "name": "Aditya", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/114663382?v=4", | ||
| "profile": "https://github.com/AaadityaG", | ||
| "contributions": ["code"] | ||
| }, | ||
| { | ||
| "login": "adityaslyf", | ||
| "name": "Aditya Varshney", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/118926308?v=4", | ||
| "profile": "https://github.com/adityaslyf", | ||
| "contributions": ["code"] | ||
| }, | ||
| { | ||
| "login": "KeyurGK", | ||
| "name": "Keyur G Kulkarni", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/56074740?v=4", | ||
| "profile": "https://keyurgk.vercel.app/", | ||
| "contributions": ["code"] | ||
| }, | ||
| { | ||
| "login": "Paarisha1", | ||
| "name": "Paarisha1", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/147527266?v=4", | ||
| "profile": "https://github.com/Paarisha1", | ||
| "contributions": ["code"] | ||
| }, | ||
| { | ||
| "login": "Bikram-ghuku", | ||
| "name": "Bikram Ghuku", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/37508038?v=4", | ||
| "profile": "https://bikram-ghuku.github.io/portfolio", | ||
| "contributions": ["code"] | ||
| }, | ||
| { | ||
| "login": "Souvik34", | ||
| "name": "Souvik", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/98397984?v=4", | ||
| "profile": "https://github.com/Souvik34", | ||
| "contributions": ["code"] | ||
| }, | ||
| { | ||
| "login": "isayanpal", | ||
| "name": "Sayan Snigdha Pal", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/102523492?v=4", | ||
| "profile": "https://github.com/isayanpal", | ||
| "contributions": ["code"] | ||
| }, | ||
| { | ||
| "login": "ItsRoy69", | ||
| "name": "Jyotirmoy Roy", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/78967360?v=4", | ||
| "profile": "https://itsroy69.github.io/Portfolio-Minimal/", | ||
| "contributions": ["code"] | ||
| }, | ||
| { | ||
| "login": "davidkrupa", | ||
| "name": "davidkrupa", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/126403373?v=4", | ||
| "profile": "https://github.com/davidkrupa", | ||
| "contributions": ["code"] | ||
| }, | ||
| { | ||
| "login": "praptisharma28", | ||
| "name": "Prapti Sharma", | ||
| "avatar_url": "https://avatars.githubusercontent.com/u/123169861?v=4", | ||
| "profile": "https://github.com/praptisharma28", | ||
| "contributions": ["code"] | ||
| } | ||
| ], | ||
| "contributorsPerLine": 7, | ||
| "linkToUsage": true | ||
| } | ||
|
|
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,50 +1,123 @@ | ||
| <h3 align="center">DoodleCollab</h3> | ||
| <div align="center"> | ||
| [](https://opensource.org/licenses/Apache-2.0) | ||
| [](#contributors-) | ||
| <a href="https://github.com/WikiPortal/DoodleCollab" alt="GitHub contributors"> | ||
|
|
||
| --- | ||
| <h1 align="center">DoodleCollab</h1> | ||
| <div align="center"> | ||
|
|
||
|  | ||
|
|
||
| </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/> | ||
| ## Related image (Project under progress) 🚧 | ||
|
|
||
| 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 👋🏻 | ||
|
|
||
| - **Take a look at the [Contributing Guidelines](CONTRIBUTING.md) for proper contributions** | ||
| - **Take a look at the [Setup Guidelines](rules/Setup.md) to setup the react app locally** | ||
|
|
||
| ## Technologies used 💻 | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| --- | ||
|
|
||
| ## 🙏 Support | ||
|
|
||
| This project needs a ⭐️ from you. Don't forget to leave a star ⭐️ | ||
|
|
||
| --- | ||
| ## Willing to help ? 👩🏻💻 | ||
|
|
||
| ## Happy Contributions !! | ||
| *A beginner to Open Source, Web Development ?* | ||
|
|
||
| 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 🔐 | ||
|
|
||
| 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 | ||
| ``` | ||
|
|
||
| 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: | ||
| <table> | ||
| <tbody> | ||
| <tr> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/AaadityaG"><img src="https://avatars.githubusercontent.com/u/114663382?v=4?s=100" width="100px;" alt="Aditya"/><br /><sub><b>Aditya</b></sub></a><br /><a href="https://github.com/WikiPortal/DoodleCollab/commits?author=AaadityaG" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/adityaslyf"><img src="https://avatars.githubusercontent.com/u/118926308?v=4?s=100" width="100px;" alt="Aditya Varshney"/><br /><sub><b>Aditya Varshney</b></sub></a><br /><a href="https://github.com/WikiPortal/DoodleCollab/commits?author=adityaslyf" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://keyurgk.vercel.app/"><img src="https://avatars.githubusercontent.com/u/56074740?v=4?s=100" width="100px;" alt="Keyur G Kulkarni"/><br /><sub><b>Keyur G Kulkarni</b></sub></a><br /><a href="https://github.com/WikiPortal/DoodleCollab/commits?author=KeyurGK" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/Paarisha1"><img src="https://avatars.githubusercontent.com/u/147527266?v=4?s=100" width="100px;" alt="Paarisha1"/><br /><sub><b>Paarisha1</b></sub></a><br /><a href="https://github.com/WikiPortal/DoodleCollab/commits?author=Paarisha1" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://bikram-ghuku.github.io/portfolio"><img src="https://avatars.githubusercontent.com/u/37508038?v=4?s=100" width="100px;" alt="Bikram Ghuku"/><br /><sub><b>Bikram Ghuku</b></sub></a><br /><a href="https://github.com/WikiPortal/DoodleCollab/commits?author=Bikram-ghuku" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/Souvik34"><img src="https://avatars.githubusercontent.com/u/98397984?v=4?s=100" width="100px;" alt="Souvik"/><br /><sub><b>Souvik</b></sub></a><br /><a href="https://github.com/WikiPortal/DoodleCollab/commits?author=Souvik34" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/isayanpal"><img src="https://avatars.githubusercontent.com/u/102523492?v=4?s=100" width="100px;" alt="Sayan Snigdha Pal"/><br /><sub><b>Sayan Snigdha Pal</b></sub></a><br /><a href="https://github.com/WikiPortal/DoodleCollab/commits?author=isayanpal" title="Code">💻</a></td> | ||
| </tr> | ||
| <tr> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://itsroy69.github.io/Portfolio-Minimal/"><img src="https://avatars.githubusercontent.com/u/78967360?v=4?s=100" width="100px;" alt="Jyotirmoy Roy"/><br /><sub><b>Jyotirmoy Roy</b></sub></a><br /><a href="https://github.com/WikiPortal/DoodleCollab/commits?author=ItsRoy69" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/davidkrupa"><img src="https://avatars.githubusercontent.com/u/126403373?v=4?s=100" width="100px;" alt="davidkrupa"/><br /><sub><b>davidkrupa</b></sub></a><br /><a href="https://github.com/WikiPortal/DoodleCollab/commits?author=davidkrupa" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/praptisharma28"><img src="https://avatars.githubusercontent.com/u/123169861?v=4?s=100" width="100px;" alt="Prapti Sharma"/><br /><sub><b>Prapti Sharma</b></sub></a><br /><a href="https://github.com/WikiPortal/DoodleCollab/commits?author=praptisharma28" title="Code">💻</a></td> | ||
| </tr> | ||
| </tbody> | ||
| <tfoot> | ||
| <tr> | ||
| <td align="center" size="13px" colspan="7"> | ||
| <img src="https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg"> | ||
| <a href="https://all-contributors.js.org/docs/en/bot/usage">Add your contributions</a> | ||
| </img> | ||
| </td> | ||
| </tr> | ||
| </tfoot> | ||
| </table> | ||
| 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 ! 🚀 | ||
| --- |
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
Oops, something went wrong.