totally_not_fb/hacker-news-cli
1
0
Fork 0
Code Releases Activity
17 Commits 2 Branches 0 Tags 169 KiB
JavaScript 90.2%
HTML 6.6%
Shell 3.2%
master
Go to file
Robert Webb f5e38cbd70 Added a sample test using supertest, axios, and sinon. 
It does not past but I can confirm it does call the api!
2019-02-17 20:20:31 -08:00
api Fixed some more linting 2019-02-17 19:58:20 -08:00
db Fixed some more linting 2019-02-17 19:58:20 -08:00
docs updated readme 2019-02-07 18:55:15 -08:00
public adding a comment backend, experimenting with static html frontend (plus bash) 2019-02-14 08:59:14 -08:00
scripts separated api path from main path 2019-02-15 17:59:55 -05:00
tests/integration Added a sample test using supertest, axios, and sinon. 2019-02-17 20:20:31 -08:00
.eslintrc Added a sample test using supertest, axios, and sinon. 2019-02-17 20:20:31 -08:00
.gitignore Added sample code for querying the HN API in node. I used node because it takes me much less time but many other languages would work. I wanted to demonstrate the ease of hackernews API. 2019-02-01 23:32:17 -08:00
.prettierignore added seed, and a template for serving the html 2019-02-07 20:59:24 -08:00
ascii.js Fixed some more linting 2019-02-17 19:58:20 -08:00
hn-client.js adding a comment backend, experimenting with static html frontend (plus bash) 2019-02-14 08:59:14 -08:00
index.js Added a sample test using supertest, axios, and sinon. 2019-02-17 20:20:31 -08:00
package-lock.json Added a sample test using supertest, axios, and sinon. 2019-02-17 20:20:31 -08:00
package.json Added a sample test using supertest, axios, and sinon. 2019-02-17 20:20:31 -08:00
README.md first commit 2019-01-28 03:40:09 -05:00

README.md

Hacker News Clone - CLI Version

README

The MVP of this project is a clone of https://news.ycombinator.com but in CLI. A user should be able to log in from the command line and be presented with a list of stories, along with a 'menu bar' that has the options in HN: news, comments, ask, show, jobs, submit (we will likely not use all of these options, but let's keep it as a clone for now).

TODOs

notes

features

  1. voting

    1. registration

      required to comment (?)

    2. search

      by popularity, date. I find it effective.

    3. threaded collapsible comments

      • All threads threaded and collapsible. maxed by default. each can be minimized individually, collapsing all contained comments.
      • main threads sorted by quality, replies chronological (?),
      • poor quality comments remain visible but dimmed according to how downvoted

    4. user karma

      • users have karma
      • user post/comment history can be seen by clicking on their profile.

    5. voting

      regiistration required min karma required for downvoting (comments only?)

    6. sort algorithms (see note below)

      • posts sorted by ratio of upvotes / newness / user karma / voodoo

    7. user control of search / sort options

      • users can view HN sorted view, chrono posts, chrono comments, (?)

    8. 'dead' (shadowbanned) profiles

      These are profiles where the user doesn't know they are 'shadowbanned', so they continue to post but can't tell that no one else can see it.

      • explicit rules and culture to encourage / discourage certain content

User Stories

  1. MVP

    • landing page has a list of articles
    • submit a story by pasting a link

  2. logging in