Skip to content

PeachBlack-Alba/github_repo_search

Repository files navigation

github_repo_search

A Flutter application that allows users to search for GitHub repositories using the GitHub API. This project demonstrates the use of Flutter, Bloc for state management, and other best practices in app development.

Features

  • Search Repositories: Users can search for GitHub repositories by keywords.
  • View Repository Details: Clicking on a repository in the search results displays detailed information about the repository.
  • Trending Repositories: The home screen displays a list of trending repositories.
  • Dark Theme Support: Supports dark mode for better readability in low-light conditions.

Getting Started

To get a local copy up and running, follow these simple steps.

#Prerequisites

Flutter installed on your machine. To install Flutter, follow the official guide. An IDE (e.g., Android Studio, VSCode) with Flutter support.

Installation

1.Clone the repo

git clone https://github.com/PeachBlack-Alba/github_repo_search.git

  1. Navigate to the project directory

cd github_repo_search

  1. Install dependencies

flutter pub get

  1. Run the app

flutter run

Usage

Use the search bar on the home screen to search for GitHub repositories. Click on any repository from the list to view more detailed information about it. You can see open issues.

Running Tests

To run all unit tests, execute the following command in the terminal:

flutter test

Demo App

Built With

Flutter - The framework used Bloc - State management GitHub API - Data source (https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#list-repositories-for-a-user--parameters)

License Distributed under the MIT License. See LICENSE for more information.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages