README.org

main
hn/README.org rendered · source · history · blame · raw

53 lines · 877 bytes

 1#+title: hn
 2
 3* what
 4front-end alternative for hacker news. php. no tracking.
 5
 6* requires
 7a web server (nginx or apache), php 8.0+, optional minify.
 8
 9* install
10#+begin_src sh
11sudo apt install nginx-full php php-cgi php-fpm minify
12git clone $repo_url
13#+end_src
14
15minify css after changes:
16
17#+begin_src sh
18minify -o static/styles.min.css static/styles.css
19#+end_src
20
21* deploy
22copy the code to your webroot. route all errors to index.php.
23
24- nginx:
25
26#+begin_src conf
27location / {
28    try_files $uri $uri/ /index.php?$args;
29}
30#+end_src
31
32apache (.htaccess):
33
34#+begin_src sh
35FallbackResource /index.php
36#+end_src
37
38* built with
39php, html, minify (for css).
40
41* todo
42- recursive descendant comment threads
43- polls (ConstructPoll)
44- pagination / load more
45
46* contributing
47see CONTRIBUTING.txt and CODE_OF_CONDUCT.txt.
48
49* versioning
50none. read the git log.
51
52* license
530bsd. see LICENSE.md.