/SearchGithub

GitHub Search API

Primary LanguageTypeScriptMIT LicenseMIT

Github Search

This is a basic application that enables users to search github users and repositories. The app consumes github API, which uses a github token provided by the developer.

Technologies Used

This project was designed with github data obtained through API requests and was generated with Angular CLI version 13.3.0. HTML5, CSS3 and vanilla Javascript, and Typescript were utilized to build this application.

Author

The author, Alex Mathenge is glad developing this site individually, along a tech path in Software Engineering at Moringa School.

Usage

The author is glad that any interested developer can use his code to advance it further or propose pull requests for improvements. One can find this app on github pages via this Link.

set-up Instructions

This project has been deployed live on github-pages for viewing. Simply click on the live deployment link provided at the project description on the github repository. For developers, you can clone this repository and run it on a local computer, manipulate it for personal practice or use, or even improve it and file a pull request for consideration of upgrading the project.

Known bugs

Currently, the project has several bugs barring proper display of queried data, and performs at minimally. Continuous improvements are underway.

SearchGithub

This project was generated with Angular CLI version 13.3.3.

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

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.

Copyright and Licence

The project is governed by an MIT Licence. Copyright (c) 2022 Alex Mathenge.