joanwanjiku/githubfinder

This app consumes the github API, lets users search github users and displays their profile.

GithubFinder

GithubFinder allows users search for github users by submitting their username through a form, then displays his/her profile along with a table containing his/her repositories.

Prerequisites

• Have git installed
• Have the latest version of NodeJs, angular-cli and typeScript installed.
• Have a text editor installed e.g VsCode, Atom

Technologies Used

• HTML, CSS, Bootstrap.
• Typescript and Angular

Project Setup

Ensure you have all the items in the prerequisites installed. To run the application:-

1. Clone the repository to a folder in your machine using git clone https://github.com/joanwanjiku/githubFinder.git
2. cd to that folder.
3. Open it on your text editor.
4. Run ng serve on the terminal.
5. After the application finishes compiling, Navigate to http://localhost:4200/. The app will automatically reload if you make any changes.

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.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.

Author

• Joan Evans
  • [email protected]

License

• MIT license | Copyright © 2020