/github-finder

Github Finder is a web application that uses the GitHub API to perform searches on GitHub and display the results to the user.

Primary LanguageTypeScriptOtherNOASSERTION

Github seach

githubsearch

Description

Github Finder is a web application that uses the GitHub API to perform searches on GitHub and display the results to the user.

Features

  1. Uses the Github API to perform searches on Github, and display the results to the users.
  2. Users page searches for user profile strictly using the user name.
  3. Repositories page searches for repositories strictly using the repository name.

Behaviour Driven Development

Behaviour Input Output
Show github profile Enter the Username in the search box and cick search Displays name, username, number of repositories
Redirect to github profile on Github website Click the view profile on github button of a Github user Opens the profile on the Github website
Redirect to a specific Github Repository Click the view on github button of a repository on repositories page Opens the Repository on Github website

Live Website

View the complete site here

Technologies Used

It is built using Angular JS, HTML, Bootstrap. The website uses components, custom directives, custom pipes, routing modules. The components in the application are:

Contributors

-Owiti Reagan

Development server

Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

contacts

  • Incase of any feedback you can reach me though:
    • OwitiReagan1
      • 0717307127

Author

REAGAN OWITI

License

MIT © @OwitiReagan