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

Enhanced Readme #208

Merged
merged 5 commits into from
Jul 17, 2024
Merged
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
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# <p align="center"> Petari - The Food Donation Management System</p>
<div id="top"></div>

## 🏆 Featured in:

<table>
<tr>
<th>Event Name</th>
<th>Event Description</th>
</tr>
<tr>
<td>GirlScript Summer of Code 2024</td>
<td>GirlScript Summer of Code is a three-month-long Open Source Program conducted every summer by GirlScript Foundation. It is an initiative to bring more beginners to Open-Source Software Development.
</tr>
</table>

<h2>Table of Contents</h2>

- [Introduction](#introduction)
Expand All @@ -10,11 +24,13 @@
- [Features](#features)
- [Contribution Guidelines](#contribution-guidelines)
- [How Can You Contribute?](#how-can-you-contribute)
- [Code of Conduct](#code-of-conduct)
- [Getting Started](#getting-started)
- [Code Style Guidelines](#code-style-guidelines)
- [Code Review Process](#code-review-process)
- [Community Guidelines](#community-guidelines)
- [Output Screenshot](#output-screenshot)
- [License](#license)
<br>

## Introduction
Expand Down Expand Up @@ -65,7 +81,7 @@ PETARI, The Food Donate WebApp, is an initiative by an organization aiming to re

# Contribution Guidelines
<a g="contribution-guidelines"></a>
Thank you for considering contributing to PETARI! We appreciate your efforts to make a positive impact on society through food redistribution and combating hunger. By contributing to PETARI, you are helping us move closer to our goal of creating a hunger-free world and reducing food waste.
Thank you for considering contributing to PETARI! We appreciate your efforts to make a positive impact on society through food redistribution and combating hunger. By contributing to PETARI, you are helping us move closer to our goal of creating a hunger-free world and reducing food waste. Please go through [Contributing Guidelines](CONTRIBUTING.md).

## How Can You Contribute?
<a h="how-can-you-contribute"></a>
Expand All @@ -81,6 +97,10 @@ There are several ways you can contribute to PETARI:

5. **Feedback**: Provide feedback on the existing features, suggest new ideas, or share your thoughts on how PETARI can be further improved.

## Code of Conduct

Please note that this project is released with a Contributor [Code of Conduct](Code_of_conduct.md). By participating in this project you agree to abide by its terms.

<p align="right">(<a href="#top">back to top</a>)</p>

## Getting Started
Expand Down Expand Up @@ -255,6 +275,10 @@ Admins have special privileges and access to manage the platform. The admin logi

![Admin Login Page](https://github.com/Sahil1786/Petari/assets/111786720/fb1cc46a-e3ad-40fd-93c6-268849e05e91)

## License

This project is under [LICENSE](LICENSE)

**Please follow me and give a star to my repository
<p align="right">(<a href="#top">back to top</a>)</p>

Expand All @@ -275,4 +299,4 @@ Admins have special privileges and access to manage the platform. The admin logi
</a>
</center>
<br>
<p align="right"><a href="#top">Back to top</a></p>
<p align="right"><a href="#top">Back to top</a></p>