Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Updated the readme with the latest changes.
  • Loading branch information
madhurimarawat authored Jun 21, 2024
1 parent ff87632 commit 80b7b6a
Showing 1 changed file with 31 additions and 19 deletions.
50 changes: 31 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ An HTML, JS, and Bootstrap-based web application that dynamically lists GitHub r

<h2>Website Design</h2>

<img width="960" title="Main Page Image" alt="Main Page Image" src="https://github.com/madhurimarawat/GitHub-Repository-Lister/assets/105432776/e55efd2a-6fe4-43c6-850e-9726cbafdfaf">
<a href="https://github-repository-topics-lister.netlify.app/"><img width="960" title="Main Page Image" alt="Main Page Image" src="https://github.com/madhurimarawat/GitHub-Repository-Lister/assets/105432776/f718b213-de2e-41b6-a5b1-1f180338f49f"></a>
<br><br>
<img width="960" title="Main Page Image" alt="Main Page Image" src="https://github.com/madhurimarawat/GitHub-Repository-Lister/assets/105432776/779129e6-6bb5-479c-8e18-3607054cd187">
<a href="https://github-repository-topics-lister.netlify.app/"><img width="960" title="Main Page Image" alt="Main Page Image" src="https://github.com/madhurimarawat/GitHub-Repository-Lister/assets/105432776/baace55a-0aeb-4071-ac07-9faef265c576"></a>
<br><br>
<img width="960" title="Main Page Image" alt="Main Page Image" src="https://github.com/madhurimarawat/GitHub-Repository-Lister/assets/105432776/b6673d2a-ed47-466a-91da-71244453c5e5">
<a href="https://github-repository-topics-lister.netlify.app/"><img width="960" title="Main Page Image" alt="Main Page Image" src="https://github.com/madhurimarawat/GitHub-Repository-Lister/assets/105432776/b6673d2a-ed47-466a-91da-71244453c5e5"></a>

<br> <br>
<img width="960" title="About Page Image" alt="About Page Image" src="https://github.com/madhurimarawat/GitHub-Repository-Lister/assets/105432776/2e460c85-bf2f-49b1-bf19-35beaa0aee71">
<a href="https://github-repository-topics-lister.netlify.app/about"><img width="960" title="About Page Image" alt="About Page Image" src="https://github.com/madhurimarawat/GitHub-Repository-Lister/assets/105432776/2e460c85-bf2f-49b1-bf19-35beaa0aee71">


## Technology Used 💻
Expand All @@ -24,21 +24,32 @@ An HTML, JS, and Bootstrap-based web application that dynamically lists GitHub r
</p>

## Description
--> One of the primary goals of frontend development is to create a smooth or "frictionless" user experience.<br><br>
--> First a user friendly and responsive interface through frontend was developed.<br><br>
--> All visual features, pixels and cross browser compatibility will be taken in account.<br><br>
--> The website design is simple and easy to work with along with an attractive interface.<br><br>
--> Websites works well on multiple devices and screen sizes, which is possible as it involves responsive design.

- **User-Centric Profiles**: See detailed GitHub user profiles with profile images, bios, locations, followers, and up to 30 public repositories. Everything is neatly centered for clarity and impact.

- **Limited Repository Display**: Due to GitHub's API limits, we show a maximum of 30 public repositories per user. This keeps things focused and easy to browse.

- **Intuitive Pagination**: Easily navigate through repositories with simple pagination controls that make browsing smooth and efficient.

- **Dynamic Loading Animation**: Enjoy a fun loading animation that keeps you entertained while we fetch the data you're looking for.

- **Unified Visual Design**: Our interface is polished and cohesive, with consistent colors, subtle shadows, and stylish buttons that make using our app a professional experience.

- **Dedicated GitHub Toolkit**: Explore deeper insights into GitHub with a dedicated page featuring detailed descriptions, repository stars, and graphics that bring GitHub data to life.

- **Enhanced Graphics Area**: Dive into a visually appealing section of toolkit where clean design elements make understanding GitHub stats and trends a breeze.

---

## Mode of Execution Used <img src="https://th.bing.com/th?id=OSAAS.67CE744F3AF9AB3181DA21630627453B&w=80&h=80&o=6&dpr=2&pid=5.1" title="Notepad++" alt="Notepad++" width="40" height="40"> </a> &nbsp;<img src="https://cdn.freebiesupply.com/logos/large/2x/netlify-logo-png-transparent.png" title="Netlify" alt="Netlify" width="40" height="40">
<h2>Notepad++</h2>
--> To begin, visit the official website &nbsp; <a href="https://notepad-plus-plus.org/downloads/"><img src="https://th.bing.com/th?id=OSAAS.67CE744F3AF9AB3181DA21630627453B&w=80&h=80&o=6&dpr=2&pid=5.1" title="Notepad++" alt="Notepad++" width="40" height="40"> </a> <br><br>
--> Download according to the platform being used like Linux, MacOs or Windows.<br><br>
--> Follow the setup wizard.<br><br>
--> After setup, we can write code in HTML and also in other languages.<br><br>
--> To see the output of HTML code open document in any browser.<br>
<ul>
<li>To begin, visit the official website &nbsp; <a href="https://notepad-plus-plus.org/downloads/"><img src="https://th.bing.com/th?id=OSAAS.67CE744F3AF9AB3181DA21630627453B&w=80&h=80&o=6&dpr=2&pid=5.1" title="Notepad++" alt="Notepad++" width="40" height="40"> </a> </li> <br>
<li>Download according to the platform being used like Linux, MacOs or Windows.</li><br>
<li>Follow the setup wizard.</li><br>
<li>After setup, we can write code in HTML and also in other languages.</li><br>
<li>To see the output of HTML code open document in any browser.
</ul>

## Hosting With Netlify

Expand Down Expand Up @@ -66,14 +77,14 @@ An HTML, JS, and Bootstrap-based web application that dynamically lists GitHub r
- Easily deployed using Netlify, ensuring accessibility and continuous updates.

- **About Page:**
- Explore the details of this project on its about page.
- Explore the details about GitHub on GitHub Toolkit page.
---

## Website Link

<p>I have hosted this Website using netlify.Click on the image below to have a look at my Website:</p>

<a href="https://github-repository-topics-lister.netlify.app/"> <img src="https://github.com/madhurimarawat/GitHub-Repository-Lister/assets/105432776/e55efd2a-6fe4-43c6-850e-9726cbafdfaf" height=100 title="Github Repository Lister website" alt="Github Repository Lister website"></a>
<a href="https://github-repository-topics-lister.netlify.app/"> <img src="https://github.com/madhurimarawat/GitHub-Repository-Lister/assets/105432776/f718b213-de2e-41b6-a5b1-1f180338f49f" height=100 title="Github Repository Lister website" alt="Github Repository Lister website"></a>

---
## Additional Resources
Expand All @@ -84,7 +95,8 @@ An HTML, JS, and Bootstrap-based web application that dynamically lists GitHub r

## Thanks for Visiting 😄

Drop a 🌟 if you find this repository useful.<br><br>
If you have any doubts or suggestions, feel free to reach me.<br><br>
- Drop a 🌟 if you find this repository useful.<br><br>
- If you have any doubts or suggestions, feel free to reach me.<br><br>
📫 How to reach me: &nbsp; [![Linkedin Badge](https://img.shields.io/badge/-madhurima-blue?style=flat&logo=Linkedin&logoColor=white)](https://www.linkedin.com/in/madhurima-rawat/) &nbsp; &nbsp;
<a href ="mailto:rawatmadhurima@gmail.com"><img src="https://github.com/madhurimarawat/Machine-Learning-Using-Python/assets/105432776/b6a0873a-e961-42c0-8fbf-ab65828c961a" height=35 width=30 title="Mail Illustration" alt="Mail Illustration📫" > </a>
<a href ="mailto:rawatmadhurima@gmail.com"><img src="https://github.com/madhurimarawat/Machine-Learning-Using-Python/assets/105432776/b6a0873a-e961-42c0-8fbf-ab65828c961a" height=35 width=30 title="Mail Illustration" alt="Mail Illustration📫" > </a><br><br>
- **Contribute and Discuss:** Feel free to open <a href= "https://github.com/madhurimarawat/GitHub-Repository-Lister/issues">issues 🐛</a>, submit <a href = "https://github.com/madhurimarawat/GitHub-Repository-Lister/pulls">pull requests 🛠️</a>, or start <a href = "">discussions 💬</a> to help improve this repository!

0 comments on commit 80b7b6a

Please sign in to comment.