GithubSearch
This project was generated with Angular CLI version 8.3.21.
Name: Anthony Muli.
Email: mulianthony561@gmail.com
Tel:+254796577998.
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.
GithubSearch is a web application that allows a user to enter a github username in the search box and returns the subjects names and description of the -public repositories-. The application uses a github API.
1.Open your github account.
2.Search for the github username:antomuli.
3.In antomuli's repositories,git clone the Quotes repository into your you -local repository- which is your machine(computer) /git clone the following link:https://github.com/antomuli/GithubSearch.git
4.npm install afterwards.
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 build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.
BDD
| Behaviour | Input | Output |
|---|---|---|
| Show github profile | Enter the Username in the search box and press enter |
Displays name, username, bio, number of repositories, Hireable, date of creating the repo, followers, following and public gists |
| Load more search Results | Click Load More button on the Find Repos page |
Adds 10 more results in the search results |
| Redirect to github profile on Github website | Click the view 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 |
The following is the live link to the project "GithubSearch":https://antomuli.github.io/GithubSearch/ This site was built using github pages:
The following include the list of technologies used:
1.Angular version 8.3.21
2.Bootsrap Version 4.3.1
3.Javascript.
4.JQuery.
5.Github Api's
Known Bugs
1.The page is 25% unresponsive.
2.The app has a limit of the number of github users you can search. eg max.=30
Run ng test to execute the unit tests via Karma.
Run ng e2e to execute the end-to-end tests via Protractor.
To get more help on the Angular CLI use ng help or go check out the Angular CLI README.
To colloborate, raech me on mulianthony561@gmail.com
MIT License
Copyright (c) 2020 Moringa School-Anthony Muli
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.