Sam-Karanja / Github-Search

This is an Angular application that uses githubSearch API to optimize searching for any github user, their repositories or just any repository that is in github.

Github-search

This is an Angular application that uses githubSearch API to optimize searching for any github user, their repositories or just any repository that is in github.

This project was generated with Angular CLI version 13.3.1.

Author

[Samuel Murigi]

Demo

Github-search

Technologies and Dependencies Used

• HTML
• CSS
• Bootstrap
• JavaScript
• TypeScript
• Angular
• Github API

User Stories (Behavior Driven Development)

1. Enter github user's username in the search bar and click search.
2. View a user's profile information on search result
3. View a user'd reposotories.

Setup Instructions

1. Fork this repository
2. Clone the forked repository in your local computer.

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.

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

5. Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory.

6. Running unit tests

Run ng test to execute the unit tests via Karma.

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

Contributions

Should you notice any bug or want to add a feature, contributions are highly welcome. Feel free to:

1. Fork this repository.
2. Clone the forked repository in your local computer.
3. Make changes.
4. Create a pull request.

Contact

[e-mail]

Licence

MIT Copyright (c) 2022

Github-Search