/Github-Search-Application

This is an application that allows users to search for other user's repositories and profile details

Primary LanguageTypeScript

GithubSearch

This is an application that allows users to search for other users' profiles and repositories on Github. It was generated with Angular CLI version 7.3.5.

Setup/ User Requirements

The user needs an internet connection to use the application.

  • User inputs any user's username on Github on the searchbar provided.
  • The App then shows the user's details as they appear on Github
  • One can go further and look at more details about the user on Github by clicking the "User profile on Github" button.
  • A list of the users repositories is also displayed and more details can be viewed as well from Github.

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.

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

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.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.

Technology Used

  • Angular JS to to create the business logic and the user- interface.
  • HTML to write the templates.
  • CSS for the app styling.
  • Markdown for the README document.

Known Bugs

There are currently no known bugs.

Support and contact details

For more information, questions, or help using the program, get in touch with me on +254 726 047102 or email: kimita.wanjiku@gmail.com.

License

MIT License

Copyright (c) 2019 Elizabeth Kimita

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, sub-license, 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 NON-INFRINGEMENT. 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.