/Github-API

This is Agular application that allows a user to enter a GitHub username into a form, submit it, and see names and descriptions of that person's public repositories. It queries from github using Github API

Primary LanguageTypeScript

GithubSearch

Author

Nelly Kamotho

Description

This is Agular CLI application that allows a user to enter a GitHub username into a form, submit it, and see names and descriptions of that person's public repositories. A person can also look for repositories based on github user name.

Live Page

https://kiira254.github.io/Github-API/home

Composed of two main components.

  • Search Users -search for users on git-hub based on their usernames.
  • Search Repositories -search for repositories on git-hub based on their authoers name.

BDD

Behavior Input Output
Search for a github profile Enter the username of the github User name Displays the name, username, number of repositories,Joining date, followers, following and lists the repos

Installation / Setup instruction

  • Open Terminal {Ctrl+Alt+T}

  • git clone https://github.com/Owiti-Charles/Git-Search.git

  • cd Git-Search

  • code . or atom . based on the text editor you have.

  • Run ng serve for a dev server.

  • Navigate to http://localhost:4200/.

  • npm install && ng serve

Technology used

  • Angular CLI
  • HTML
  • CSS
  • Bootstrap
  • Typescript
  • Generated with Angular CLI version 8.2.1.

Known Bugs

  • No known bug now but pull requests are encouraged

Contact Information

If you have any question or contributions, please email me at [nkamotho57@gmail.com]

License

  • MIT License:
  • Copyright (c) 2019 Nelly Kamotho