README.md

GithubApi

Description

A responsive webapp that enables users to search Github users, view their profile, followers and those following. Figma Design

Behaviour Driven Development

The user is able to:

• Search user using username
• View profile
• View repos
• View followers
• View those following
• Go to their Github profile
• Go to their Github repos

Technologies Used

• HTML & CSS
• Bootstrap
• Angular CLI
• ngx-ui-loader

Setup Instructions and Installation

• Clone this repository to a location in your file system. git clone https://github.com/BrianMwevi/github-api.git
• Open terminal command line then navigate to the root folder of the application. cd github-api
• Run npm install to install dependancies

Development server

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.

Build

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

Further Angular help

To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.

App Screenshot

Development

Want to contribute? Awesome!!

To fix a bug or modules enhancement, follow these steps:

• Fork the repo
• Create a new branch (git switch -c improve-feature)
• Make the appropriate changes in the files
• Add changes to reflect the changes made
• Commit your changes (git commit -am 'improve feature')
• Push to the branch (git push origin improve-feature)
• Create a Pull Request

Known Bugs

If you find any bug, open an issue here by including your search query and the expected result.

If you'd like to request a new function, feel free to do so by opening an issue here. Include sample queries and their corresponding results.

Link to Live Site : https://brianmwevi.github.io/github-api/

License

MIT Licence Copyright (c) 2022 Brian Mwevi

Licence

Go Back To Top