Skip to content

A website where users may enter a GitHub username into a form, submit it, and see names and descriptions of that person's public repositories. A person can also look for repositories.

Notifications You must be signed in to change notification settings

emmakamau/GithubSearch

Repository files navigation

GithubSearch

A website where users may enter a GitHub username into a form, submit it, and see names and descriptions of that person's public repositories. A person can also look for repositories. Click to view

Contributor

Emmaculate Kamau

Technologies used

  1. Javascript
  2. CSS
  3. HTML
  4. Bootstrap
  5. Typescript
  6. Angular Js

Requirements

NodeJs and Angular installed or an IDE with the same functionality. VS Code is a great choice.

Setup and instruction

  1. Clone the repository here.
  2. Extract and open the folder.
  3. Run ng serve --open from the console.
  4. Navigate to http://localhost:4200/ on your preferred browser.

Development

To fix a bug or enhance an existing module, follow these steps:

  • Fork the repo
  • Create a new branch (git checkout -b 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

Behaviour Driven Development

BDD focuses on how the user will interact with the application.

What you will see and experience:

  1. Landing page with an image and a form.
  2. Enter a username and click on Search User.
  3. A profile of the user including their avatar is displayed.
  4. Click on View Repositories and get directed to a list of the user's repositories.
  5. Click on the Search New User to display the form and search for a new user.

Known Bugs

If you find a bug or would like to request a new function, reach out to me via Email: emmaculatewkamau@gmail.com or on LinkedIn

License

MIT

Copyright (c) 2022 Emmaculate Kamau

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

About

A website where users may enter a GitHub username into a form, submit it, and see names and descriptions of that person's public repositories. A person can also look for repositories.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published