Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modifications in README.md #216 #255

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 37 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@

# Poll It Up ~ A community polling app with unlimited potential
# <p align=center> Poll It Up ~ A community polling app with unlimited potential

<p align="center">
<img src="https://user-images.githubusercontent.com/88102392/239682688-0c5debf5-d414-4916-87d8-e1a710773ae3.png" alt="image">
</p>

<h1 align="center">Contributions Accepted under GSSoC '23</h1>
## 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!<br>
- 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.<br>
- 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!<br>
- Poll It Up is **PWA optimized**, so you can download it and run it as if it were a native app!

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->

Expand All @@ -14,26 +14,35 @@
<!-- ALL-CONTRIBUTORS-BADGE:END -->
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)


<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge" alt="PRs Welcome" /> <a href="https://github.com/agamjotsingh18/pollitup/pulls" target="_blank"><img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr/agamjotsingh18/pollitup?style=for-the-badge" /></a> <a href="https://github.com/agamjotsingh18/pollitup/issues" target="_blank"><img alt="GitHub issues" src="https://img.shields.io/github/issues/agamjotsingh18/pollitup?style=for-the-badge" /></a> <a href="https://github.com/agamjotsingh18/pollitup/blob/master/README.md#contributors-" target="_blank"></a>

## 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!.<br>
- 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.<br>
- 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!<br>
- 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 <a href="https://github.com/agamjotsingh18/pollitup/blob/main/CONTRIBUTING.md">contribution guide.</a>

## Code of Conduct

Check out the <a href="https://github.com/agamjotsingh18/pollitup/blob/main/CODE_OF_CONDUCT.md">Code of Conduct</a> to know an inclusive environment that respects all contributions.

## License

This project is <a href="https://github.com/agamjotsingh18/pollitup/blob/main/LICENSE">Licensed</a> under the MIT license.

## Before You Start
<ul>
<li>Try to maintain the file format & folder structure. </li>
<li>Try to maintain proper file names. </li>
<li>Don't use capital or spaces for files names instead use _ or -. </li>
<li>Don't use capital or spaces for file names instead use _ or -. </li>
</ul>

## Getting Started
## 🚀 Getting Started
Please follow these simple steps to start working:<br>

**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.

Expand Down Expand Up @@ -86,10 +95,10 @@ git checkout -b <your_branch_name>
**11.** Track your changes:heavy_check_mark: .

```
git add .
git add.
```

**12.** Commit your changes .
**12.** Commit your changes.

```
git commit -m "Relevant message"
Expand All @@ -100,10 +109,10 @@ git commit -m "Relevant message"
git push -u origin <your_branch_name>
```

**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`.
Expand All @@ -113,7 +122,7 @@ git push -u origin <your_branch_name>
![Whoohooo!](https://media3.giphy.com/media/sgswHaZw5yklq/giphy.gif?cid=ecf05e4752791acvsi719im8d4lib8z33uxbga6secdplwq2&rid=giphy.gif)

## 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
Expand All @@ -122,10 +131,16 @@ See the open issues for a full list of proposed features (and known issues).<br>
- Documentation at some places.<br>
- Addition of Some Cool Styles.<br>
- Addition of More Useful Libraries.<br>
- Give Chance to user to add their Library.<br>
- Give a Chance to users to add their Library.<br>
- More Features for More Interactivity in Site.<br>
- Developing in Next Js with more features.<br>

# <p align="center">Contributions Accepted under GSSoC '23
<p align="center">
<img src="https://user-images.githubusercontent.com/88102392/239682688-0c5debf5-d414-4916-87d8-e1a710773ae3.png" alt="image">
</p>


## Contributors:

### The Wonderful People Who Contributed Here
Expand Down Expand Up @@ -175,7 +190,7 @@ See the open issues for a full list of proposed features (and known issues).<br>

<hr>
<p align="left">
<h3 align="left">Contact:</h3>
<h3 align="left">Connect:</h3>
<a href="https://www.linkedin.com/in/agamjot-singh/" target="blank"><img align="center" src="https://img.icons8.com/bubbles/100/000000/linkedin.png" height="75" width="75" /></a>&nbsp;&nbsp;&nbsp;&nbsp;
<a href="https://twitter.com/_agamjotsingh/" target="blank"><img align="center" src="https://img.icons8.com/bubbles/344/twitter-squared.png" height="75" width="75" /></a>&nbsp;&nbsp;&nbsp;&nbsp;
<a href="mailto:[email protected]" target="blank"><img align="center" src="https://img.icons8.com/bubbles/100/000000/email.png" height="75" width="75" /></a>&nbsp;&nbsp;&nbsp;&nbsp;
Expand Down
Loading