aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 194ffd1cc10ef2c6ad55622658401b1980374ad6 (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
# hn

[hn](https://hn.cleberg.net) is a simple front-end alternative for Hacker 
News, focusing on privacy and simplicity.

## TODO

A scratch pad of ideas that may be useful to implement:

- [ ] Add functionality to view item-specific page with comments.
- [ ] Add functionality to view a user's profile.
- [ ] Add functionality to load more items or paginate?
- [ ] Add minimal CSS.

## Development

This just uses plain PHP and HTML, no special package managers or development 
tools needed. Just start editing the files with your favorite editor and use a 
server with PHP if you want to view the results or deploy your own version.

## Deployment

To deploy, ensure you have a publicly-available web server and configure it to 
fallback with all errors to the `index.php` file rather than returning a `404` 
error.

For nginx, include the following snippet in your website's conf file:

```conf
location / {
        # First attempt to serve request as file, then
        # as directory then fall back to index.php
        try_files $uri $uri/ /index.php?$args;
}
```

For Apache, you can include the following snippet in a `.htaccess` file within 
the directory you're serving the PHP file from:

```conf
FallbackResource /index.php
```