Skip to content

A web-based solution that allows users to search GitHub profiles and go through their GitHub repositories.

License

Notifications You must be signed in to change notification settings

sirajeddineaissa/github-repo-search

Repository files navigation

Contributors Forks Stargazers Issues MIT License

About The Project

Showcase Project

GitHub Repo Search is a web-based solution that allows users to search GitHub profiles and go through their GitHub repositories. It also allows users to view some of the data related to each repository (title, description, stars...) and redirect them to its URL.

Technologies

  • React
  • ChakraUI

Getting Started

Prerequisites

Use the Yarn Package Manager

  • Install Yarn
 npm install -g yarn

Installation

  1. Clone the repository
    git clone https://github.com/sirajeddineaissa/github-repo-search
  2. Install dependencies
    yarn install

Running The App

  • In Development Mode
 yarn start
  • In Production Mode
 yarn build && npx serve -s build

Running Tests

 yarn test

Running Storybook

 yarn storybook

Usage

Homepage

Homepage

Search Users

Search Users

Search User Repositories

Search Repositories

View Repository Data

View Repositories via Modal

Switch Between Light/Dark Themes

Enable Dark Mode

Roadmap

  • Added Light/Dark Mode support
  • Added GitHub user search feature
  • Added GitHub repository search and filtering feature
  • Make it possible to see similar repositories to the searched repository

Contribute

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/feature-name)
  3. Commit your Changes (git commit -m 'commit text here')
  4. Push to the Branch (git push origin feature/feature-name)
  5. Open a Pull Request

Make sure you give this project a ⭐.

License

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

Feedback About This Exercise

I enjoyed using ChakraUI's stunning visual components to build the front-end. I also learned a lot about TypeScript and how its type-safe capability ensures a smooth and clean coding environment. Besides, It's always good to keep a clean good-qualiy codebase. Moreover, I enjoyed playing with Storybook and setting it up to visualize various components within its dashboard. This project was definitely challenging especially when it comes to debugging TypeScript.

About

A web-based solution that allows users to search GitHub profiles and go through their GitHub repositories.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published