summaryrefslogtreecommitdiff
path: root/README.nfo
blob: d498d9fe725d318b8d67efd6369d9c3b33e147b2 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
┌──────────────────────────────────────────────────────────────┐
│  H N                                       [ KRZ ]   krz.sh  │
└──────────────────────────────────────────────────────────────┘

WHAT
  front-end alternative for hacker news. php. no tracking.

REQUIRES
  a web server (nginx or apache), php 8.0+, optional minify.

INSTALL
      sudo apt install nginx-full php php-cgi php-fpm minify
      git clone $repo_url

  minify css after changes:

      minify -o static/styles.min.css static/styles.css

DEPLOY
  copy the code to your webroot. route all errors to index.php.

  nginx:

      location / {
          try_files $uri $uri/ /index.php?$args;
      }

  apache (.htaccess):

      FallbackResource /index.php

BUILT WITH
  php, html, minify (for css).

TODO
  - recursive descendant comment threads
  - polls (ConstructPoll)
  - pagination / load more

CONTRIBUTING
  see CONTRIBUTING.txt and CODE_OF_CONDUCT.txt.

VERSIONING
  none. read the git log.

LICENSE
  0bsd. see LICENSE.md.

┌──────────────────────────────────────────────────────────────┐
│  krz.sh                                                      │
└──────────────────────────────────────────────────────────────┘