Skip to content
This repository was archived by the owner on May 14, 2024. It is now read-only.

Commit d2abe3a

Browse files
committed
week 1 hw content change
1 parent cb42b03 commit d2abe3a

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

Week1/MAKEME.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Figure 1 below shows an example of what your application will look like.
7474
This application does 2 things:
7575

7676
1. It makes connection to the GitHub API and retrieves all the repositories found in the [HackYourFuture account](https://www.github.com/hackyourfuture).
77-
2. It displays those repositories in an alphabetically-oreded list. When a user clicks on any of the repository names it will show more details about it.
77+
2. It displays those repositories in an alphabetically-ordered list. When a user clicks on any of the repository names it will show more details about it.
7878

7979
### Getting an overview
8080

@@ -127,20 +127,24 @@ As you'll experience in your job, you'll be exposed to an already existing codeb
127127
https://api.github.com/orgs/HackYourFuture/repos?per_page=100
128128
```
129129

130-
This URL is special, as it gives us data in JSON format (Try it out in your browser!). This type of URL is also known as an `endpoint`, an address that we can use to send a request to in order to get data. Learn more about endpoints [here](https://smartbear.com/learn/performance-monitoring/api-endpoints/).
130+
This URL is special, as it gives us data in JSON format (Try it out in your browser!). This type of URL is also known as an `endpoint`, an address that we can use to send an HTTP request to in order to get data.
131131

132-
Note the query string `?per_page=100` in the above URL. If you don't specify this `query string` you will only get the first 30 repositories (the default `per_page` is 30, which we know because it says so in the [API documentation](https://developer.github.com/v3/#pagination)).
132+
- Learn more about endpoints [here](https://smartbear.com/learn/performance-monitoring/api-endpoints/).
133+
134+
Note the query string `?per_page=100` in the above URL. If you don't specify this `query string` you will only get the first 30 repositories (the default `per_page` is 30. How do we know? It says so in the [API documentation](https://developer.github.com/v3/#pagination)).
135+
136+
> Before using a public API it's always best practice to read the documentation. The developers have written down exactly how to understand and use it!
133137
134138
### Week 1 Assignment
135139

136-
The assignment for this week is to produce a functional application that looks similar to Figure 1:
140+
The assignment for this week is to produce a functional web application that looks similar to Figure 1:
137141

138142
![UI Example](./assets/hyf-github.png)
139143

140-
Functionally, the application should do the following:
144+
Here are the basic requirements:
141145

142146
1. Make a HTTP Request to the endpoint: https://api.github.com/orgs/HackYourFuture/repos?per_page=100
143-
2. Display the first 10 items in the HTML file (write JavaScript to add element to the DOM)
147+
2. Display the first 10 items in the HTML file (write JavaScript to add the elements to the DOM)
144148
3. Show feedback when an error has happened
145149

146150
Modify the following files:

0 commit comments

Comments
 (0)