imma7 / github-search

This is a simple Angular 5 application that allows you to search for GitHub users using their username.

GitHubSearch

By Immanuel Mugambi

To preview this app follow this link to the live & deployed website: [GitHub Search] (https://imma7.github.io/GitHub-Search/)

This project was developed in Angular 5 as part of the Independent Project for CORE.

Description

This is a simple Angular 5 application that allows you to search for GitHub users using their username.

This project is generated with Angular CLI version 1.7.4.

Setup/Installation Requirements

-For the application to run on local machine, you must have NPM and Angular installed. -Bootstrap(4) is also required for the custom styling used and recommended especially for the cards element to work.

When all the Requirements have been met, you can clone the application by running the command git clone https://github.com/Imma7/GitHub-Search.git on your local machine and you can run your own version by opening a terminal and navigating to the cloned folder and running ng serve -o,this will initiate and open a server that will allow you to view the application. You can also access the generated application from the link provided if you first want to see how the application works.

Known Bugs/Updates/Corrections

-There are currently no known bugs within the application. -You can also create a pull request with further improvements and I will add them onto the project

Specifications

The following are the specifications for this application:

INPUT

-The application accepts 1 input from the user.

INPUT TYPE

-The application accepts Text as the input type

Required inputs:

A GitHub username is required for the application to give the appropriate result.

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.

Built Using

-Angular 5 -Bootstrap

Contact Details

You can contact me at [email protected]

Licence

Copyright (c) 2018 Immanuel Mugambi