Commit 2a57019b0c
Unsigned
Layout: unified · split
README.md +75 −10
| @@ -3,23 +3,36 @@ | ||
| 3 | 3 | [hn](https://hn.cleberg.net) is a simple front-end alternative for Hacker |
| 4 | 4 | News, focusing on privacy and simplicity. |
| 5 | 5 | |
| 6 | ## TODO | |
| 6 | ## Getting Started | |
| 7 | 7 | |
| 8 | A scratch pad of ideas that may be useful to implement: | |
| 8 | These instructions will get you a copy of the project up and running on your | |
| 9 | local machine for development and testing purposes. See deployment for notes on | |
| 10 | how to deploy the project on a live system. | |
| 9 | 11 | |
| 10 | - [ ] Add functionality to view item-specific page with comments. | |
| 11 | - [ ] Add functionality to view a user's profile. | |
| 12 | - [ ] Add functionality to load more items or paginate? | |
| 13 | - [ ] Add minimal CSS. | |
| 12 | ### Prerequisites | |
| 14 | 13 | |
| 15 | ## Development | |
| 14 | - A web server (e.g., Nginx or Apache) | |
| 15 | - PHP | |
| 16 | 16 | |
| 17 | This just uses plain PHP and HTML, no special package managers or development | |
| 18 | tools needed. Just start editing the files with your favorite editor and use a | |
| 19 | server with PHP if you want to view the results or deploy your own version. | |
| 17 | ### Installing | |
| 18 | ||
| 19 | Install the dependencies, using the web server of your choice: | |
| 20 | ||
| 21 | ``` | |
| 22 | sudo apt install nginx-full php | |
| 23 | ``` | |
| 24 | ||
| 25 | Clone the repo: | |
| 26 | ||
| 27 | ``` | |
| 28 | git clone https://git.sr.ht/~cmc/hn/ | |
| 29 | ``` | |
| 20 | 30 | |
| 21 | 31 | ## Deployment |
| 22 | 32 | |
| 33 | Deployment is as easy as copying the code to your webroot. No special packages | |
| 34 | or tools required. | |
| 35 | ||
| 23 | 36 | To deploy, ensure you have a publicly-available web server and configure it to |
| 24 | 37 | fallback with all errors to the `index.php` file rather than returning a `404` |
| 25 | 38 | error. |
| @@ -40,3 +53,55 @@ the directory you're serving the PHP file from: | ||
| 40 | 53 | ```conf |
| 41 | 54 | FallbackResource /index.php |
| 42 | 55 | ``` |
| 56 | ||
| 57 | ## Built With | |
| 58 | ||
| 59 | * [PHP](https://www.php.net/) - The scripting language | |
| 60 | * [HTML](https://html.spec.whatwg.org/multipage/) - The markup language | |
| 61 | ||
| 62 | ## Contributing | |
| 63 | ||
| 64 | Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of | |
| 65 | conduct, and the process for submitting pull requests to us. | |
| 66 | ||
| 67 | ## Versioning | |
| 68 | ||
| 69 | This project currently doesn't use versioning. See the git log instead. | |
| 70 | ||
| 71 | ## Authors | |
| 72 | ||
| 73 | * **CMC** - *Literally everything* - [cmc](https://sr.ht/~cmc/) | |
| 74 | ||
| 75 | ## License | |
| 76 | ||
| 77 | This project is licensed under the Unlicense - see the | |
| 78 | [LICENSE.md](LICENSE.md) file for details. | |
| 79 | ||
| 80 | ## Acknowledgments | |
| 81 | ||
| 82 | * Hat tip to anyone whose code was used | |
| 83 | * Inspiration | |
| 84 | * etc | |
| 85 | ||
| 86 | ------------------------------------ | |
| 87 | ||
| 88 | # hn | |
| 89 | ||
| 90 | ||
| 91 | ## TODO | |
| 92 | ||
| 93 | A scratch pad of ideas that may be useful to implement: | |
| 94 | ||
| 95 | - [ ] Add functionality to view item-specific page with comments. | |
| 96 | - [ ] Add functionality to view a user's profile. | |
| 97 | - [ ] Add functionality to load more items or paginate? | |
| 98 | - [ ] Add minimal CSS. | |
| 99 | ||
| 100 | ## Development | |
| 101 | ||
| 102 | This just uses plain PHP and HTML, no special package managers or development | |
| 103 | tools needed. Just start editing the files with your favorite editor and use a | |
| 104 | server with PHP if you want to view the results or deploy your own version. | |
| 105 | ||
| 106 | ## Deployment | |
| 107 | ||