An open API service indexing awesome lists of open source software.

https://github.com/chanaiagwata/angular-github-api

This is a website that allows the user to search for Github usernames and repositories. This is achieved using Github Rest API requests.
https://github.com/chanaiagwata/angular-github-api

angular html typescript

Last synced: about 2 months ago
JSON representation

This is a website that allows the user to search for Github usernames and repositories. This is achieved using Github Rest API requests.

Awesome Lists containing this project

README

          

# Angular-Github-API

## By Chanai Agwata
### (MS School Project)

* [Overall Description](https://github.com/chanaiagwata/Angular-Github-API#overall-project-description)

* [Setup Instructions](https://github.com/chanaiagwata/Angular-Github-API#setup-instructions)

* [License](https://github.com/chanaiagwata/Angular-Github-API#license)

* [Author's Info](https://github.com/chanaiagwata/Angular-Github-API#authors-info)

## Overall Project Description

This is a website that enables users to search Github user's information by entering a username and submit it. The application fetches names and descriptions of public repositories

### User Stories
* The user can enter a username and submit.
* The user can see user and repository information.
* The user can see time that has passed since the repository was created.

### How it Works
* Load the application,
* On the searchfield, enter username,
. Information will be loaded on keyup,
* Click the submit button to list the quote on the application.
![screenshot](https://raw.githubusercontent.com/chanaiagwata/Angular-Github-API/master/pageimage.png)
### Languages and Frameworks
* HTML
* CSS
* Javascript
* Typescript
* Bootstrap
* Angular
### Known Bugs
* No bug has been detected so far.
### Contributions
* This project is open for improvement suggestions and interested parties can fork and pull request at any time.

## Setup Instructions
* copy the url on arrow down,
* Clone on your computer,
* Go live or start your server.
#### Note
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 13.3.1.

## 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](https://karma-runner.github.io).

## 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](https://angular.io/cli) page.

* Click this link for additional information https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/cloning-and-forking-repositories-from-github-desktop

### Live Site
Access it here https://chanaiagwata.github.io/Quote-App/

## License
[MIT LICENSE](LICENSE)

## Authors Info

Linkedin Profile - [Chanai Agwata](https://www.linkedin.com/in/chanai-agwata-90a345146/)

[Go Back to the top](#portfolio)