Browse Source

docs(clonernews): correct subject grammar

1274-oddlength
davhojt 2 years ago committed by Dav Hojt
parent
commit
36a9dc25e2
  1. 27
      subjects/clonernews/README.md

27
subjects/clonernews/README.md

@ -1,35 +1,30 @@
## clonernews
### Objectives
Technology is a rapidly evolving sector. As a programmer, it is not always easy to keep up to date with every new advancement.
Technology nowadays continue to evolve. As a programmer or developer you must be updated with this exponential evolution of technology.
Tech news (like Hacker News) is a really great way to keep up to date with the exponential evolution of technology, as well as tech jobs and much more. Some websites do not offer very appealing propositions to consume their media.
This is where tech news shines, just like Hacker News where you can see all about new technology, jobs and much more, but some websites do not perform very well or their are not so appealing.
So your objective for this raid is to create an UI for [`HackerNewsAPI`](https://github.com/HackerNews/API).
So your objective for this raid is to create an UI for the [HackerNews API](https://github.com/HackerNews/API).
You must handle at least:
- Posts, this includes :
- Posts: including:
- [stories](https://github.com/HackerNews/API#ask-show-and-job-stories)
- [jobs](https://github.com/HackerNews/API#ask-show-and-job-stories)
- [polls](https://github.com/HackerNews/API#items)
- [comments](https://github.com/HackerNews/API#items), each comment must have the proper post parent.
- [comments](https://github.com/HackerNews/API#items): each comment must have the proper post parent.
Post and comments must be ordered by newest post to oldest.
You must not load all posts at once. You must be able to load posts when ever the users need to see more posts. This can be done with the help of [event](https://developer.mozilla.org/en-US/docs/Web/Events).
[Live Data](https://github.com/HackerNews/API#live-data) : is one of the features from this Hacker News API, you can handle requests so that the news you provide are updated.
- You must have a section that present the newest information. You will have to notify the user at least every 5 seconds, whenever the live data is updated. In other words, after every 5 seconds if a change was made in the live data, you have to notify the user.
You must not load all posts at once, so that you only load posts once the users need to see more posts. This can be done with the help of [events](https://developer.mozilla.org/en-US/docs/Web/Events).
Currently this API does not present [rate limit](https://en.wikipedia.org/wiki/Rate_limiting). But that does not mean you should abuse/overload the API!!!
The point of the project is to keep users updated, so we'll need to inform our users of changes to the data using [Live Data](https://github.com/HackerNews/API#live-data). Create a section that presents the newest information. You'll need to notify the user at least every 5 seconds, whenever the live data is updated.
Best ways you can avoid rate limiting :
Currently this API does not present a [rate limit](https://en.wikipedia.org/wiki/Rate_limiting), but that does not mean that you should abuse or overload the API.
Best ways you can avoid rate limiting:
- optimize your code to eliminate any unnecessary requests
- usage of throttling/debouncing function to regulates the amount of requests
- usage of a throttling/debouncing function to regulate the number of requests,
### Optional
You can handle sub-comments for each stories, jobs and polls this meaning nested comments
You can handle sub-comments for stories, jobs and polls, by implementing nested comments.

Loading…
Cancel
Save