/Github-Profile-Viewer

A repository created for the purpose of submiting an assignment for Fyle Web Dev Internship .

Primary LanguageJavaScript

GitHub Profile Viewer

Welcome to the GitHub Profile Viewer! This web application allows users to search for repositories and GitHub users. The project is built using HTML, CSS, JavaScript for the front-end, and the server is implemented using Express.js.

Features

  • Repository Search: Users can search for repositories using keywords. image

  • User Search: Users can search for GitHub users by username.

  • Pagination: Pagination feature for repositories to handle large sets of data.

  • Clickable Repository Headings: Repository headings are clickable and linked to the original repository. image

  • Display of Languages and Description: Each repository displays the languages used and its description.

  • Total Stars Count: Total number of stars given to the repository is also mentioned.

  • 404 Page: If a user does not exist, a 404 page is displayed. image

Installation

To run this project locally, follow these steps:

  1. Clone this repository to your local machine using git clone https://github.com/himanishu-2512/Github-Profile-Viewer
  2. Navigate to the project directory in your terminal.
  3. Open the index.html in your favourite browser.
  4. Navigate to the server folder by using cd server
  5. Install the required dependencies using npm install.
  6. Start the server using npm start.
  7. Now got to index.html on web browser. You are ready to go.

Usage

  • Use the search bar for repositories to enter keywords and find relevant repositories.
  • Use the search bar for users to search for GitHub users by their usernames.
  • Click on the headings of repositories to visit the original repository.
  • Navigate through the pagination to explore more repositories.

Contributing

If you'd like to contribute to this project, follow the standard GitHub flow:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/your-feature-name).
  3. Make your changes.
  4. Commit your changes (git commit -am 'Add some feature').
  5. Push to the branch (git push origin feature/your-feature-name).
  6. Create a new Pull Request.

License

This project is licensed under the MIT License.

Acknowledgements

  • This project was made possible by the use of Express.js for the server implementation.
  • Special thanks to GitHub for providing the API used for repository and user data.
  • Thanks to the open-source community for their valuable contributions.

Contact

If you have any questions, suggestions, or feedback, feel free to contact.

Thank you for exploring the GitHub Profile Viewer! We hope you find it useful and informative.