/GithubSearch

An angular app that allows a user to enter their GitHub Username and view their repositories.

Primary LanguageTypeScript

PROJECT NAME

GITHUB SEARCH PROJECT

AUTHOR NAME

TRACY OGUTU

PROJECT DESCRIPTION

This project is an angular application that allows a user to access their github details by inputting their github username into a search engine. It contains:

  • Navigation bar

  • A user input form

  • A display of github details such as:

    • Github repositories

    • Date of account creation

PROJECT SET UP INSTRUCTIONS

This project was generated with Angular CLI version 8.3.14.

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.

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.

Further help

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

USER INTERACTION

  1. Click on the search tab on the navigation bar
  2. Type in your Github username on the search engine
  3. You will then view your Github details

TECHNOLOGIES USED

LANGUAGES

  • Angular JS

  • Html

  • CSS

  • Markdown

FRAMEWORK

  • Bootstrap

CONTACT INFORMATION

Email: tracyogutu@gmail.com

Phone:+254 719 614 987

MIT License

Copyright (c) 2019 Tracy Ogutu

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.

LINK TO LIVE SITE ON NETLIFY

https://githubsearchtracyogutu.netlify.com/