GITHUB PROFILE SEARCH

Author- Sheila Sharon Wambui Karani.

Description

This is an Angular CLI application that allows users to look up Github users' profile and repositories using one's username only.

Table of contents

• Demo

• Technologies

• Known Bugs

• Setup

• Contact

• Licence

Demo

Here is a working live demo : https://github-api-beta.vercel.app/

Technologies

1. HTML 5
2. CSS 3
3. Bootstrap 4
4. Typescript
5. Angular
6. Github API

Known Bugs

There are curently no known bugs.

Setup

Prerequisites

You will need to have

1. Node
2. Npm
3. Angular CLI

• You can download manually and pass it to your root directory.

• Alternatively you can clone it directly to your folder:

$ git clone  https://github.com/DevSheila/GithubAPI.git

• Change Directory to GithubAPI

$ cd GithubAPI

• Run ng serve for a dev server. Navigate to http://localhost:4200/. The app 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.

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 Protractor.

Contact

In case of any question or contributions, contact me at sheilasharon10@gmail.com

Licence

MIT License

Copyright (c) 2021 DevSheila