updated readme

This commit is contained in:
notnull 2019-02-07 18:55:15 -08:00
parent 9e90002113
commit 1a2a77beca
2 changed files with 17 additions and 22 deletions

View File

@ -1 +0,0 @@
curl -d {"title":"", "text": ""} -H Content-Type: application/json -X POST http://localhost:1337/api/articles

View File

@ -1,37 +1,33 @@
* 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
**** voting
***** registration
The MVP of this project is a clone of https://news.ycombinator.com but in CLI.
A user should be able to:
- read a list of articles in the database from the command line
- create a new story by posting a link and a title
- vote up or down on a story
** voting
*** registration
required to comment (?)
***** search
*** search
by popularity, date. I find it effective.
***** threaded collapsible comments
*** 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
***** user karma
*** user karma
- users have karma
- user post/comment history can be seen by clicking on their profile.
***** voting
*** voting
regiistration required
min karma required for downvoting (comments only?)
***** sort algorithms (see note below)
*** sort algorithms (see note below)
- posts sorted by ratio of upvotes / newness / user karma / voodoo
***** user control of search / sort options
*** user control of search / sort options
- users can view HN sorted view, chrono posts, chrono comments, (?)
***** 'dead' (shadowbanned) profiles
*** '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.
- [[https://news.ycombinator.com/newsguidelines.html][explicit rules]] and culture to encourage / discourage certain content
*** User Stories
**** MVP
- landing page has a list of articles
- submit a story by pasting a link
**** logging in