An open API service indexing awesome lists of open source software.

https://github.com/masterivanic/flow.launcher.plugin.repoengine

Repo Search Engine is a powerful Flow Launcher plugin designed to help you quickly search
https://github.com/masterivanic/flow.launcher.plugin.repoengine

Last synced: 4 months ago
JSON representation

Repo Search Engine is a powerful Flow Launcher plugin designed to help you quickly search

Awesome Lists containing this project

README

          

# Repo Search Engine - Flow Launcher Plugin

![Flow Launcher](https://img.shields.io/badge/Flow%20Launcher-Plugin-blue)
![GitHub](https://img.shields.io/badge/GitHub-Repo%20Search-green)

Repo Search Engine is a powerful Flow Launcher plugin designed to help you quickly search for GitHub repositories directly from your Flow Launcher search bar. Whether you're looking for a specific repository, exploring trending projects, or just browsing through GitHub, this plugin makes it easy and efficient.

## Features

- **Quick Search**: Search for GitHub repositories without leaving Flow Launcher.
- **Instant Results**: Get instant search results as you type.
- **Repository Details**: View key details like repository name, description, stars, forks, and more.
- **Open in Browser**: Quickly open the repository in your default web browser.
- **Customizable**: Configure the plugin to suit your needs.

## Installation

1. **Install Flow Launcher**: If you haven't already, download and install [Flow Launcher](https://www.flowlauncher.com/).

2. **Install the Plugin**:
- Open Flow Launcher.
- Type `pm install RepoSearchEngine` and press Enter.
- The plugin will be installed automatically.

3. **Run Tests locally**:
`pytest -vvv`

4. **Configure the Plugin**:
- After installation, you can configure the plugin by typing `RepoSearchEngine settings` in Flow Launcher.
- Customize settings like default search filters, number of results, etc.

## Usage

1. **Search for Repositories**:
- Open Flow Launcher.
- Type `gh` followed by your search query (e.g., `gh react`).
- Press Enter to see the results.

2. **View Repository Details**:
- Select a repository from the search results to view more details.
- Details include the repository name, description, stars, forks, and more.

3. **Open Repository in Browser**:
- Select a repository and press `Enter` to open it in your default web browser.

## Configuration

You can customize the plugin settings to better suit your needs:

- **Default Search Filters**: Set default filters like language, stars, forks, etc.
- **Number of Results**: Control the number of results displayed.
- **Open in Browser**: Choose whether to open the repository in a new tab or the current tab.

To access the settings, type `RepoSearchEngine settings` in Flow Launcher.

## Contributing

We welcome contributions! If you'd like to contribute to the development of Repo Search Engine, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Submit a pull request.

For more information, please read our [Contributing Guidelines](CONTRIBUTING.md).

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Support

If you encounter any issues or have any questions, please open an issue on the [GitHub repository](https://github.com/masterivanic/flow.launcher.plugin.repoengine/issues).

## Acknowledgments

- Thanks to the Flow Launcher team for creating such an amazing tool.
- Thanks to the GitHub API for providing the data needed for this plugin.

---

Happy searching! 🚀