GitScanner is an Angular application that pulls data about user accounts and public repositories from GitHub.
The user can search public repositories by searching either by username or repository name.
The entire functionality of the application is made possible by interaction with the GitHub API.
The main functionalities are:
- Fetch GitHub Repositories and details using Github API
- View personal account details
- View personal account repositories
- Query sample Github accounts
- Routing respective user account to their respective repositories
- Searching repositories by both username and repo name
To start using this project:
git clone https://github.com/kelvinMakamu/git-scanner.git
cd git-scanner
npm install
ng serve
Navigate tohttp://localhost:4200/
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.
Run ng test
to execute the unit tests via Karma.
Run ng e2e
to execute the end-to-end tests via Protractor.
- HTML5
- CSS3
- Bootstrap
- TypeScript
- GIT
MIT License
Copyright (c) 2020 GitScanner
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.