/GitHubSearch

An application that allows the user to search for usernames on Github and get user profiles and repositories back.

Primary LanguageTypeScriptMIT LicenseMIT

GITHUB SEARCH

This is an application that allows you to search for users on github.

Date of current version ~ October 18th,2021

By Maryann Mwikali

Description

This application allows you to search for github users and have their github information displayed that is their profile photos and a list of their repositories.

Setup/Installation Requirements

  • Navigate to the repository's about section
  • Click on the live link posted up.
  • Navigate around the application to see intended use.

Further development

  • Navigate to the code section next to the About and copy the link provided
  • Fork or clone the repository into your local machine and work on changes deemed necessary
  • Before cloning you need to have Angular CLI and npm installed.
  • Run ng build to build the project. The build artifacts will be stored in the dist/ directory.
  • 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.
  • 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.
  • Run ng test to execute the unit tests via Karma.
  • Run ng e2e to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities
  • To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page

Known Bugs

Data persistence has not been implemented.

Technologies Used

This project was generated with Angular CLI version 12.2.9.

Support and contact details

In case of anything, bugs issues or complimentary stuff kindly reach me at @mwikali119@gmail.com

License

Copyright(c)2021 GHS