This project was generated with Angular CLI version 8.0.1.
GithubSearch is an application that lets a user search for ones github profile by keying in their username. On submission, they should be able to see the users details such as name, public repositories, profile photo among others. The application utilizes Github API to perform the such functionality/
| Behavior Our program should handle | Input Example | Output Example |
|---|---|---|
| A user enters a github username and expects to get the github profile that corresponds to that username. | username:thepsalmist | the user should see thepsalmist's github profile, including the prpfile photo, public repos and others |
| A user entres a Repository and expects to get the repository's details | Repository:Git-search | the user should see the repository name, description among other details. |
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.
The GithubSearch app requires the following to run:
- angular v6.0 +
- Node.js v8+
- npm v5+
To start using this project run the following commands: 1. git clone https://github.com/thepsalmist/GithubSearch 2. cd to the GithubSearch project directory 3. npm install 4. atom . (to open on atom editor) 5. from your terminal run the command to load the app on your live server
$ ng serve -o- From your browser you can access the app on
http://localhost:4200/- HTML
- CSS
- TypeScript
- Angular v6(Framework)
https://thepsalmist.github.io/GithubSearch/
Contact:xf.xavierfrank@gmail.com
MIT License Copyright (c) 2019 thepsalmist
To get more help on the Angular CLI use ng help or go check out the Angular CLI README.