Enhance README by Adding GitHub Repository Statistics Section and Project Title GIF [Fixed #173]

[Karthik3904]

closes #173
closes #168

Description:

This pull request includes the following enhancements to the project's README:

1. Enhanced Project Title with GIF:
   • A GIF has been added to the project title section for a more dynamic and appealing visual presentation.

Recording.2024-10-24.183937.mp4

2. Added GitHub Repository Statistics:

   • A section has been added to display important repository statistics like:
     • ⭐ Stars
     • 🍴 Forks
     • 🐛 Open Issues
     • 🔔 Open PRs
     • 🎯 Closed PRs

   These stats will provide a quick overview of the repository's activity and engagement, making it more informative for potential contributors.

These improvements aim to make the README more engaging and informative for users and contributors alike.

Please label this PR with:

• gssoc-ext for contributions under GirlScript Summer of Code Extended.
• hacktoberfest-accepted to ensure it counts towards Hacktoberfest.

Thank you for reviewing my contribution! Let me know if any further changes are required.

[github-actions]

Thank you for submitting your pull request! 🙌 We'll review it as soon as possible. In the meantime, please ensure that your changes align with our chaotic CONTRIBUTING.md. If there are any specific instructions or feedback regarding your PR, we'll provide them here. Thanks again for your contribution! 😊

[github-actions]

Ensure the PR matches the requirements mentioned in the Contribution guide. The maintainer might get in touch to enusre quality. Thanks for your time

[jvedsaqib]

@Karthik3904 Can you please remove repo stats as it was already done by another contributor

[Karthik3904]

Hi [@jvedsaqib ],

I wanted to apologize for adding the GitHub repository stats without discussing it with you first. I have removed it in the latest commit.

I appreciate your understanding, and I'll make sure to check in on future changes like this before proceeding. Thank you again for your patience and for considering my pull request!

Best regards,
[@Karthik3904 ]

[rohitinu6]

@Karthik3904
Please make the following changes:

1. As mentioned in issue 168, you need to update the image with the image of the webpage available at main.py.
2. Also add steps to run the main.py file which is a part of issue 168
3. Update the overview section
4. Images in the performance metrics section is not visible

[Karthik3904]

Hi [@rohitinu6]

I have completed the changes requested in issue 168, and I would like to summarize the work done:

Updated the image: I have replaced the existing image with the screenshot of the webpage available in main.py, as requested.

Added steps to run main.py: Clear instructions to run the Flask application have been added to the README.

I have already included a GIF format for the title, which enhances the visuals of the project.

However, for the following two changes: 3. Update the overview section 4. Fix the visibility of images in the performance metrics section

I would like to raise these as a separate issue since I am focusing on completing my Hacktoberfest 2024 contributions. This will allow me to address the remaining tasks with proper attention in the next pull request.

Could you kindly accept my current pull request so I can count this towards Hacktoberfest 2024? I will ensure the remaining tasks are completed promptly in the next PR.

Thank you for understanding!

Best regards,
[@Karthik3904 ]

[rohitinu6]

@Karthik3904 appreciate your work
for the overview section, please go through the existing version of readme.md and ensure that it remains same.

[Karthik3904]

I made changes in overview section for adding steps executing main.py by using flask app only .
If you want to add any changes please let me know.

[Karthik3904]

Dear @rohitinu6 ,

I hope this message finds you well. I kindly request you to review and merge my pull request at your earliest convenience. Additionally, if the contribution meets your standards, please provide the hacktoberfest-accepted label.
Let me know if any further changes are required.

Thank you for your time and consideration.

Best regards,
@Karthik3904

[rohitinu6]

Existing:

Your work:

Please make the changes

[Karthik3904]

I made the following changes. Thank You for your valuable time

[rohitinu6]

@Karthik3904 , please sync fork with the latest changes so as to merge the pr

[Karthik3904]

I've synced my fork with the latest changes. Thank you for accepting my PR!

[Karthik3904]

As I mentioned before I rised a separate issue for
3. Update the overview section
4. Fix the visibility of images in the performance metrics section
in issue number #196 please assign me in that issue.
Thank You for your valuable time

[Mayureshd-18]

@Karthik3904 Assigned you #196 .
Please merge the changes into this same pr.

Thanks and regards

[Karthik3904]

Thank you for accepting the first set of changes! To keep things organized for Hacktoberfest2024, could you please merge this pull request as-is? I’ll be happy to create a new pull request for the second issue’s changes.

This way, it will also help me meet the Hacktoberfest contribution guidelines. Thanks again for your understanding and support!

[Karthik3904]

Please merge my pull request or it will removed from hacktoberfest for not merging

[Mayureshd-18]

Looks good to me!

[github-actions]

🎉🎉 Thank you for your contribution! Your PR #184 has been merged! 🎉🎉

[Karthik3904]

Please Merge and close this Pull Request and i rised another PR and made the changes @Mayureshd-18 mentioned kindly provide labels merge and close that PR also Thank You for your support