GitApp

This project was generated with Angular CLI version 13.3.1.

By Charles Muvaka

It is a web application that allows users to search people on gitHub - GitApp.

Table of Content

Description
Installation Requirement
Technology Used
Development Server
Reference
Authors Info

Description

QuoteHome is a web application that enables users to search for differents users who have accounts on git hub and then it displays the repositories they have.

Installation

Requirements

Either a computer,phone,tablet or an Ipad
An access to the Internet

Technology Used

HTML - which was used to build the structure of the pages.
CSS - which was used to style the pages.
JavaScript - Used in manipulating the html content.
TypeScript - Used in manipulating the html content.

SetUp instructions and installation

Clone this repository to a location in your file system.
Open terminal command line then navigate to the root folder of the application.
Open index.html on your Browser.

  $ git clone  https://github.com/CharlesMuvaka12345/gitApp.git
  $ cd ../path/to/the/file
  $ code .

Behaviour Driven Development

There is a form to collect users Typed gitHub userName
- Input - Enter Github userName.
- output - Page loads containing the Github users information.
Loads a 404 error page incase user types a userName not in github
- input - User Name not in github
- output - 404 page error.

Go Back to the top

DevelopMent

Need to contribute?? Follow the following steps.

Fork the repo
Create a new branch

 $ git switch -c (improve-feature)

Make the required changes in the file.
Add changes to reflect the changes made.
Commit your changes.

$ git commit -am (improve-feature)

Push to the branch

$ git push origin (improve-feature)

Create a Pull Request

Development server

Run ng serve for a dev server. Navigate to http://localhost:4200/. The application will automatically reload if you change any of the source files.

Code scaffolding

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.

Known Bugs

If you find any bug, open an issue here by including your search query and the expected result.

Any suggestions or corrections to the code would highly be appreciated

link to live site: https://charlesmuvaka12345.github.io/gitApp/

Reference

Materialize CSS Go Back to the top

License

MIT License

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

Authors Info

Linked - charles-muvaka