doktatech / github-search

Application that lets users search for GitHub users plus any repository on the GitHub platform

Github-Search

A search engine that allows its users to search on the git hub platform, 07/05/19 Version 1

By Rewel Kinyanjui

Description

This search engine enables users to search for repos in the github platform. Moreover a user of this app can also be able to search for Github users which in turn returns the details of that particular user such as number of Repos, Followers and the people following them.

Setup/Installation Requirements

Fork the or clone this repo Run the code on you favorite text editor Serve it on liveserve Alternatively: Click on the gh-pages url on the description Supports HTML5 browser.

Known Bugs

Application does not search for repos in this first version

Technologies Used

HTML - To structure the pages of the app CSS - To add styling to the pages. Angular CLI version 7.3.6. The Github API key. TypeScript- for operation logic

B.D.D

Input	Behaviour	Output
User submits a Github username search query	The Application searches the API Key for the requested User	The application returns returns the username, his/her repos on the GitHub platform, number of followers and those following
Use submits a Github repository they wish to find	The application fetches all the repos present in the platform from the search query	Application returns all repos present search using the passed parameter

Support and contact details

Any contributions are welcome through provided contacts in the profile page

License

MIT License Copyright (c) 2019 Rewel Kinyanjui

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.