Skip to content

Commit

Permalink
rahaf-nidal-class10-js-fetch (#125)
Browse files Browse the repository at this point in the history
  • Loading branch information
Rofy87 authored May 19, 2021
1 parent 238f702 commit 426b22b
Show file tree
Hide file tree
Showing 4 changed files with 159 additions and 0 deletions.
68 changes: 68 additions & 0 deletions class-10-js-fetch/rahaf-nidal/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# GitHub Search App

## GitHub API

You will be using the GitHub API for this project. You can view documentation
for this API [here](https://developer.github.com/v3/). This is an open API: no
API key or authentication is required for the endpoints we will be using.

Notice the GitHub API documentation includes the following excerpt. They require
you to add a custom header to your requests.

<blockquote>
By default, all requests to https://api.github.com receive the v3 version of the REST API. We encourage you to explicitly request this version via the Accept header.
</blockquote>

```text
Accept: application/vnd.github.v3+json
```

#### [User Search Endpoint](https://developer.github.com/v3/search/#search-users)

You can search for users matching a certain name. For example, if we wanted to
find all users name `octocat`, we would make a `GET` request to
`https://api.github.com/search/users?q=octocat`. To view the response, you can
copy and paste that URL into your browser.

This endpoint is rate limited. This means the API will stop returning data if
you make more than
[10 requests per minute](https://developer.github.com/v3/search/#rate-limit).

#### [User Repos Endpoint](https://developer.github.com/v3/repos/#list-user-repositories)

You can find all the public repositories for a user using this endpoint. For
example if we wanted to find all the repositories for a user with GitHub
username `octocat`, we would make a `GET` request to
`https://api.github.com/users/octocat/repos`. To view the response, you can copy
and paste that URL into your browser.

This endpoint is rate limited. This endpoint will stop returning data if you
make more than
[60 requests in an hour](https://developer.github.com/v3/#rate-limiting).

## Deliverables

You are going to build a JavaScript application which searches GitHub for users
by name and displays the results on the screen. Clicking on a specific user will
show all the repositories for that user.

1. The `index.html` file has a form with a search input. When the form is
submitted, it should take the value of the input and search GitHub for user
matches using the [User Search Endpoint](#user-search-endpoint).
2. Using the results of the search, display information about the users to the
page. (You might include showing their username, avatar and a link to their
profile.)
3. Clicking on one of these users should send a request to the
[User Repos Endpoint](#user-repos-endpoint) and return data about all the
repositories for that user.
4. Using the response from the Users Repos Endpoint, display all the
repositories for that user on the page.

## Bonus

- Toggle the search bar between searching for users by keyword and searching for
repos by keyword by adding an extra button. Hint: you can use the same search
bar for this, but you may need to create a variable which stores what the
current search type is (user or repo). The endpoint to search repositories by
keyword is
[here](https://developer.github.com/v3/search/#search-repositories).
15 changes: 15 additions & 0 deletions class-10-js-fetch/rahaf-nidal/index.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#main {
display: flex;
flex-direction: column;
align-items: center;

}

#github-container {
display: flex;
}

ul {
list-style: none;
width:50%;
}
33 changes: 33 additions & 0 deletions class-10-js-fetch/rahaf-nidal/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<html>
<head>
<meta charset='UTF-8'/>
<meta name='viewport' content='width=device-width, initial-scale=1.0'/>
<meta http-equiv='X-UA-Compatible' content='ie=edge'/>
<title>Document</title>
<script src='js/index.js'></script>
<link rel='stylesheet' href='index.css'/>
</head>
<body>
<div id='main'>

<h2>GitHub Search</h2>

<form id='github-form'>
<input id='search' type='text' name='search'>
<input type='submit' name='submit' id="submit"/>
</form>

<div id='github-container'>
<ul id='user-list'>

</ul>

<ul id='repos-list'>

</ul>
</div>

</div>

</body>
</html>
43 changes: 43 additions & 0 deletions class-10-js-fetch/rahaf-nidal/js/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
document.addEventListener("DOMContentLoaded", () => {
const name = document.querySelector("#search");
const ul = document.querySelector("#user-list");
const ulRepo = document.querySelector("#repos-list");

document.querySelector("#submit").addEventListener("click", function (e) {
e.preventDefault();

if (name.value) {
fetch(`https://api.github.com/search/users?q=${name.value}`)
.then(response => response.json())
.then(json => printNames(json, ul, ulRepo));
} else {
alert("please insert a value");
}
});
});
function printNames(json, ul, ulRepo) {
ul.innerHTML = "";
ulRepo.innerHTML = "";

for (elem of json.items) {
let li = document.createElement("li");
li.innerHTML = `<p> <img src="${elem.avatar_url}" width="50"> <br/>${elem.login}</p>`;
li.id = elem.login;
ul.appendChild(li);
li.addEventListener("click", function () {
printRepos(event.currentTarget.id, ulRepo);
});
}
}
function printRepos(user, ulRepo) {
ulRepo.innerHTML = "";
fetch(`https://api.github.com/users/${user}/repos`)
.then(response => response.json())
.then(json => {
for (elem of json) {
let li = document.createElement("li");
li.innerText = elem.name;
ulRepo.appendChild(li);
}
});
}

0 comments on commit 426b22b

Please sign in to comment.