first commit

This commit is contained in:
notnull 2019-01-28 03:40:09 -05:00
commit e224e68ca2
3 changed files with 160 additions and 0 deletions

80
README.md Normal file
View File

@ -0,0 +1,80 @@
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](https://news.ycombinator.com/newsguidelines.html) 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

43
html/vision.html Normal file
View File

@ -0,0 +1,43 @@
<h1 id="hacker-news-clone---cli-version">Hacker News Clone - CLI Version</h1>
<p>The MVP of this project is a clone of <a href="https://news.ycombinator.com" class="uri">https://news.ycombinator.com</a> 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).</p>
<h2 id="features">features</h2>
<h3 id="voting">voting</h3>
<ol>
<li><p>registration</p>
<p>required to comment (?)</p></li>
<li><p>search</p>
<p>by popularity, date. I find it effective.</p></li>
<li><p>threaded collapsible comments</p>
<ul>
<li>All threads threaded and collapsible. maxed by default. each can be minimized individually, collapsing all contained comments.</li>
<li>main threads sorted by quality, replies chronological (?),</li>
<li>poor quality comments remain visible but dimmed according to how downvoted</li>
</ul></li>
<li><p>user karma</p>
<ul>
<li>users have karma</li>
<li>user post/comment history can be seen by clicking on their profile.</li>
</ul></li>
<li><p>voting</p>
<p>regiistration required min karma required for downvoting (comments only?)</p></li>
<li><p>sort algorithms (see note below)</p>
<ul>
<li>posts sorted by ratio of upvotes / newness / user karma / voodoo</li>
</ul></li>
<li><p>user control of search / sort options</p>
<ul>
<li>users can view HN sorted view, chrono posts, chrono comments, (?)</li>
</ul></li>
<li><p>'dead' (shadowbanned) profiles</p>
<p>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.</p>
<ul>
<li><a href="https://news.ycombinator.com/newsguidelines.html">explicit rules</a> and culture to encourage / discourage certain content</li>
</ul></li>
</ol>
<h2 id="user-stories">User Stories</h2>
<h3 id="mvp">MVP</h3>
<ul>
<li>landing page has a list of articles</li>
<li>submit a story by pasting a link</li>
</ul>
<h3 id="logging-in">logging in</h3>

37
org/_hncli.org Normal file
View File

@ -0,0 +1,37 @@
* 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
required to comment (?)
***** search
by popularity, date. I find it effective.
***** 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
- users have karma
- user post/comment history can be seen by clicking on their profile.
***** voting
regiistration required
min karma required for downvoting (comments only?)
***** sort algorithms (see note below)
- posts sorted by ratio of upvotes / newness / user karma / voodoo
***** user control of search / sort options
- users can view HN sorted view, chrono posts, chrono comments, (?)
***** '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