From a3ac47da7a80016a52aa0acd642a813c5a4e9be5 Mon Sep 17 00:00:00 2001
From: Iqra Firdose <114678694+iqrafirdose@users.noreply.github.com>
Date: Thu, 6 Jul 2023 23:14:55 +0530
Subject: [PATCH 1/3] Modifications in README.md #216
I did modifications in Read Me, aligned the sections and I added pollitup website, contributing file, code_of_conduct, and license files in read me, and fixed some typos.
---
README.md | 59 ++++++++++++++++++++++++++++++++++---------------------
1 file changed, 37 insertions(+), 22 deletions(-)
diff --git a/README.md b/README.md
index 4e794e7..450d4ed 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,11 @@
-# Poll It Up ~ A community polling app with unlimited potential
+# Poll It Up ~ A community polling app with unlimited potential
-
- 
-
-
-Contributions Accepted under GSSoC '23
+## About The Project
+- Teachers, members of the government, and even concerned citizens can **launch polls** about problems they are facing to get opinions on the best method to approach the problem. Or, anyone can create polls just for fun!
+- The community can pick and choose which polls are most important for them, this can allow the community to prioritize the most urgent polls that could potentially cause drastic reforms.
+- Easily find polls near you. You can answer polls related to problems that are arising in your community that can help better the environment, aid in the growth of local startups, allow you to share your ideas with your local government, and so much more!
+- Poll It Up is **PWA optimized**, so you can download it and run it as if it were a native app!
@@ -14,26 +14,35 @@
[](https://opensource.org/licenses/MIT)
-
-## About The Project
-- Teachers, members of the government, and even concerned citizens can launch polls about problems they are facing to get opinions on the best method to approach the problem. Or, anyone can create polls just for fun!.
-- The community can pick and choose which polls are most important for them, this can allow the community to prioritize the most urgent polls that could potentially cause drastic reforms.
-- Easily find polls near you. You can answer polls related to problems that are arising in your community that can help better the environment, aid in the growth of local startups, allow you to share your ideas with your local government, and so much more!
-- Poll It Up is **PWA optimized**, so you can download it and run it as if it were a native app!
+## Demo 💻
+ Website: https://pollitup.vercel.app/
+
+ ## Contribute
+
+We welcome contributions to our project.
+Before making a contribution, check the contribution guide.
+
+## Code of Conduct
+
+Check out the Code of Conduct to know an inclusive environment that respects all contributions.
+
+## License
+
+This project is Licensed under the MIT license.
## Before You Start
- Try to maintain the file format & folder structure.
- Try to maintain proper file names.
-- Don't use capital or spaces for files names instead use _ or -.
+- Don't use capital or spaces for file names instead use _ or -.
-## Getting Started
+## 🚀 Getting Started
Please follow these simple steps to start working:
-**1.** If you want to work on issue then comment. If you get assigned, Fork [this](https://github.com/agamjotsingh18/pollitup.git) repository.
+**1.** If you want to work on the issue then comment. If you get assigned, Fork [this](https://github.com/agamjotsingh18/pollitup.git) repository.
**2.** Clone your forked copy of the project.
@@ -86,10 +95,10 @@ git checkout -b
**11.** Track your changes:heavy_check_mark: .
```
-git add .
+git add.
```
-**12.** Commit your changes .
+**12.** Commit your changes.
```
git commit -m "Relevant message"
@@ -100,10 +109,10 @@ git commit -m "Relevant message"
git push -u origin
```
-**14.** Open a Pull Request with a name of the issue and describe about your changes with reasons. To create a pull request, click on `compare and pull requests`. Please ensure you compare your feature branch to the desired branch of the repository you are supposed to make a PR to.
+**14.** Open a Pull Request with the name of the issue and describe your changes with reasons. To create a pull request, click on `compare and pull requests`. Please ensure you compare your feature branch to the desired branch of the repository you are supposed to make a PR to.
-**15.** Add appropriate title and description to your pull request explaining your changes and efforts done.
+**15.** Add an appropriate title and description to your pull request explaining your changes and efforts.
**16.** Click on `Create Pull Request`.
@@ -113,7 +122,7 @@ git push -u origin
## Add Your Name
-Once your PR got merged, do not forget to add your name in [CONTRIBUTING.md](https://github.com/agamjotsingh18/pollitup/blob/main/CONTRIBUTING.md) file.
+Once your PR got merged, do not forget to add your name to [CONTRIBUTING.md](https://github.com/agamjotsingh18/pollitup/blob/main/CONTRIBUTING.md) file.
Further instructions are mentioned there.
## Roadmap
@@ -122,10 +131,16 @@ See the open issues for a full list of proposed features (and known issues).
- Documentation at some places.
- Addition of Some Cool Styles.
- Addition of More Useful Libraries.
- - Give Chance to user to add their Library.
+ - Give a Chance to users to add their Library.
- More Features for More Interactivity in Site.
- Developing in Next Js with more features.
+# Contributions Accepted under GSSoC '23
+
+
+
+
+
## Contributors:
### The Wonderful People Who Contributed Here
@@ -175,7 +190,7 @@ See the open issues for a full list of proposed features (and known issues).
-
Contact:
+Connect:
From 24b5a28c100974239f5d600e4b9b0c997f55540d Mon Sep 17 00:00:00 2001
From: Iqra Firdose <114678694+iqrafirdose@users.noreply.github.com>
Date: Thu, 6 Jul 2023 23:15:31 +0530
Subject: [PATCH 2/3] Update update_readme.py #216
---
update_readme.py | 126 ++++++++++++++++++++++++++++++++---------------
1 file changed, 86 insertions(+), 40 deletions(-)
diff --git a/update_readme.py b/update_readme.py
index 2974976..2198b4c 100644
--- a/update_readme.py
+++ b/update_readme.py
@@ -31,41 +31,49 @@
# Construct the updated README content
new_readme_content = '''\
-# Poll It Up ~ A community polling app with unlimited potential
+# Poll It Up ~ A community polling app with unlimited potential
-
-
-
-
-Contributions Accepted under GSSoC '23
+## About The Project
+- Teachers, members of the government, and even concerned citizens can **launch polls** about problems they are facing to get opinions on the best method to approach the problem. Or, anyone can create polls just for fun!
+- The community can pick and choose which polls are most important for them, this can allow the community to prioritize the most urgent polls that could potentially cause drastic reforms.
+- Easily find polls near you. You can answer polls related to problems that are arising in your community that can help better the environment, aid in the growth of local startups, allow you to share your ideas with your local government, and so much more!
+- Poll It Up is **PWA optimized**, so you can download it and run it as if it were a native app!
-'''
-new_readme_content += '\n[ + '-orange.svg?style=flat-square)](https://github.com/agamjotsingh18/pollitup/graphs/contributors)\n'
-new_readme_content += '''
+[](https://github.com/agamjotsingh18/pollitup/graphs/contributors)
+
[](https://opensource.org/licenses/MIT)
-
-## About The Project
-- Teachers, members of the government, and even concerned citizens can launch polls about problems they are facing to get opinions on the best method to approach the problem. Or, anyone can create polls just for fun!.
-- The community can pick and choose which polls are most important for them, this can allow the community to prioritize the most urgent polls that could potentially cause drastic reforms.
-- Easily find polls near you. You can answer polls related to problems that are arising in your community that can help better the environment, aid in the growth of local startups, allow you to share your ideas with your local government, and so much more!
-- Poll It Up is **PWA optimized**, so you can download it and run it as if it were a native app!
+## Demo 💻
+ Website: https://pollitup.vercel.app/
+
+ ## Contribute
+
+We welcome contributions to our project.
+Before making a contribution, check the contribution guide.
+
+## Code of Conduct
+
+Check out the Code of Conduct to know an inclusive environment that respects all contributions.
+
+## License
+
+This project is Licensed under the MIT license.
+
## Before You Start
- Try to maintain the file format & folder structure.
- Try to maintain proper file names.
-- Don't use capital or spaces for files names instead use _ or -.
+- Don't use capital or spaces for file names instead use _ or -.
-## Getting Started
+## 🚀 Getting Started
Please follow these simple steps to start working:
-
-**1.** If you want to work on issue then comment. If you get assigned, Fork [this](https://github.com/agamjotsingh18/pollitup.git) repository.
+**1.** If you want to work on the issue then comment. If you get assigned, Fork [this](https://github.com/agamjotsingh18/pollitup.git) repository.
**2.** Clone your forked copy of the project.
@@ -78,7 +86,6 @@
```
cd pollitup
```
-
**4.** Add a reference(remote) to the original repository.
```
@@ -90,64 +97,76 @@
git remote -v
```
-**6.** Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository).
+**6.** Install dependencies
+```
+npm install --legacy-peer-deps
+**7.** Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository).
```
git pull upstream main
```
-**7.** Create a new branch.
+**8.** Start the development server
```
-git checkout -b
+npm start
```
-**8.** Perform your desired changes to the code base.
+**9.** Create a new branch.
+```
+git checkout -b
+```
+**10.** Perform your desired changes to the code base.
-**9.** Track your changes:heavy_check_mark: .
+
+**11.** Track your changes:heavy_check_mark: .
```
-git add .
+git add.
```
-**10.** Commit your changes .
+**12.** Commit your changes.
```
git commit -m "Relevant message"
```
-**11.** Push the committed changes in your feature branch to your remote repo.
+**13.** Push the committed changes in your feature branch to your remote repo.
```
git push -u origin
```
-
-**12.** Open a Pull Request with a name of the issue and describe about your changes with reasons. To create a pull request, click on `compare and pull requests`. Please ensure you compare your feature branch to the desired branch of the repository you are supposed to make a PR to.
+**14.** Open a Pull Request with the name of the issue and describe your changes with reasons. To create a pull request, click on `compare and pull requests`. Please ensure you compare your feature branch to the desired branch of the repository you are supposed to make a PR to.
-**13.** Add appropriate title and description to your pull request explaining your changes and efforts done.
+**15.** Add an appropriate title and description to your pull request explaining your changes and efforts.
-**14.** Click on `Create Pull Request`.
+**16.** Click on `Create Pull Request`.
-**15** Voila!
+**17** Voila!
## Add Your Name
-Once your PR got merged, do not forget to add your name in [CONTRIBUTING.md](https://github.com/agamjotsingh18/pollitup/blob/main/CONTRIBUTING.md) file.
+Once your PR got merged, do not forget to add your name to [CONTRIBUTING.md](https://github.com/agamjotsingh18/pollitup/blob/main/CONTRIBUTING.md) file.
Further instructions are mentioned there.
-
## Roadmap
See the open issues for a full list of proposed features (and known issues).
- Documentation at some places.
- Addition of Some Cool Styles.
- Addition of More Useful Libraries.
- - Give Chance to user to add their Library.
+ - Give a Chance to users to add their Library.
- More Features for More Interactivity in Site.
- Developing in Next Js with more features.
+# Contributions Accepted under GSSoC '23
+
+
+
+
+
## Contributors:
### The Wonderful People Who Contributed Here
@@ -157,9 +176,36 @@
-'''
-new_readme_content += "\n".join(contributor_info)
-new_readme_content += '''
+
+
+ 
agamjotsingh18
📖 |
+ 
Arnabdaz
📖 |
+ 
actions-user
📖 |
+ 
AmoghCreator
📖 |
+ 
dakshgupta2002
📖 |
+ 
ayush25102001
📖 |
+
+
+ 
Bhavil-Ahuja
📖 |
+ 
mkswagger
📖 |
+ 
coder-mohit
📖 |
+ 
boradesanket13
📖 |
+ 
aceta-minophen
📖 |
+ 
jyotivakare33
📖 |
+ 
PrajwalDhule
📖 |
+
+
+ 
ajeetdangi2
📖 |
+ 
Akanksha-Sen
📖 |
+ 
rsinghcodes
📖 |
+ 
Shubham29012001
📖 |
+ 
Thrillseekr
📖 |
+ 
debsouryadatta
📖 |
+ 
ronitblenz
📖 |
+
+
+ 
yeshwanth235
📖 |
+ 
yogesh0509
📖 |
@@ -170,7 +216,7 @@
-
Contact:
+Connect:
From 1a0f2eaa4a894a9c2c42fe09876ccca96e06c190 Mon Sep 17 00:00:00 2001
From: Iqra Firdose <114678694+iqrafirdose@users.noreply.github.com>
Date: Thu, 20 Jul 2023 21:36:00 +0530
Subject: [PATCH 3/3] Update update_readme.py
---
update_readme.py | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/update_readme.py b/update_readme.py
index 2198b4c..6876201 100644
--- a/update_readme.py
+++ b/update_readme.py
@@ -40,6 +40,9 @@
- Poll It Up is **PWA optimized**, so you can download it and run it as if it were a native app!
+'''
+new_readme_content += '\n[ + '-orange.svg?style=flat-square)](https://github.com/agamjotsingh18/pollitup/graphs/contributors)\n'
+new_readme_content += '''
[](https://github.com/agamjotsingh18/pollitup/graphs/contributors)
@@ -176,6 +179,9 @@
+'''
+new_readme_content += "\n".join(contributor_info)
+new_readme_content += '''
agamjotsingh18
📖 |