/My-Github

This is a Github Search where users may enter a Github username into a form, submit it and see names and descriptions of that person's public repositories. Using the GitHub API to retrieve this information

Primary LanguageTypeScript

My Github

RICHARD ORITO OMONDI

This project was generated with Angular CLI version 13.0.4.

Table of Content

Description

This is a Github Search where users may enter a Github username into a form, submit it and see names and descriptions of that person's public repositories. Using the GitHub Api to retrive this information

Installation

Requirements

  • Either a computer,phone,tablet or an Ipad

  • An access to the Internet

Go Back to the top

Technology Used

  • Angular js - Used to Build the Entire Project.

  • HTML - which was used to build the structure of the pages.

  • CSS - which was used to style the pages.Also used Global links ,bootstrap CDN,Materialize CDN.

  • Figma-which was used to design the prototype of the UI.

  • JavaScript , Typescript - Used for the interactivity of the page and the form validation , submit.

Behaviour Driven Development

  • Users can search through a github username and see repositories, last updated , how many followers they have , how many people they are following ,the languages used to develop their applications , if they are hirerable , location etc.
  • Working with components (parent and child) and usiing components,directives and classes to establish this.

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.

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 a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.

Reference

  • LMS
  • Youtube
  • W3schools
  • freecodeCamp
  • stackOverFlow
  • MDN docs

Go Back to the top

Licence

MIT License

Copyright (c) [2022] [Richard Orito]

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.

Go Back to the top

Author Info

Slack Profile - Richard Omondi

LinkedIn - Richard Orito

Gmail - richard.omondi@student.moringaschool.com

Github - RICHIE ORITO

Live Link

LiveLink- Gh-pages

Go Back to the top