GitHub Repo Search

GitHub Repo Search: A Streamlit app for searching GitHub repositories based on user criteria.

Table of contents

• Overview
• Features
• Getting Started
• Usage
• Documentation Directory
• Templates Directory
• Search Results Directory
• Contributing
• Credits
• License

Overview

GitHub Repo Search allows you to search GitHub repositories using specific criteria, providing a convenient way to find repositories based on your needs.

Features

• Search GitHub repositories by various criteria.
• View detailed information about search results.
• Navigate and explore GitHub repositories seamlessly.

Getting Started

To run gitreposearch locally, follow these steps:

1. Clone this repository to your local machine.
2. Install the required dependencies by running pip install -r requirements.txt.
3. Run the Streamlit app using the command streamlit run gitreposearch.py.

Usage

Once the app is running, you can:

• Enter your search criteria in the input field.
• Click the "Search" button to retrieve GitHub repositories matching your criteria.
• Explore the search results and click on repository links for more details.

Documentation Directory

The Docs directory contains the following essential documentation files:

• App-Instructions.md: Instructions on how to use the GitRepoSearch application effectively.
• Contributing.md: Guidelines for contributing to GitRepoSearch, including coding standards and submission processes.
• Installation.md: Step-by-step instructions for installing and setting up GitRepoSearch on your local machine.
• License.md: The BSD 3-Clause License under which GitRepoSearch is distributed. Refer to this file for licensing details.

These documents are also available inside the application in the left sidebar menu.

Templates Directory

The "templates" directory contains templates for various purposes, including:

• Templates-Instructions.md: Instructions on using the templates provided in the "templates" directory.
• Bug-Report-Template.md: Template for reporting bugs encountered in the application.
• Feature-Request-Template.md: Template for suggesting new features or improvements.
• Issue-Report-Template.md: Template for reporting general issues or problems.
• Pull-Request-Template.md: Template for creating pull requests for code changes.

You can access these templates from within the application in the left sidebar menu.

Search Results Directory

The search-results directory contains markdown files that represent the search results obtained from GitHub based on user search criteria. Each markdown file in this directory corresponds to a specific search query and provides detailed information about the repositories found.

To view the search results:

1. Navigate to the search-results directory.
2. Select the markdown file corresponding to your search query.
3. Open the markdown file to review the list of repositories and their descriptions.

You can also review search results directly from the application's left sidebar menu.

Contributing

We welcome contributions to GitRepoSearch! To contribute, please follow the guidelines outlined in the Documentation directory, specifically the Contributing.md file. Here's a summary of the contribution process:

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

For detailed instructions and guidelines, refer to the Contributing.md file in the Docs directory.

Credits

• Streamlit - The app framework used.
• GitHub API - API used for repository search.

License

This project is licensed under the BSD 3-Clause License. See the LICENSE file for more details.