diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 34 |
1 files changed, 18 insertions, 16 deletions
@@ -1,18 +1,18 @@ # hn -[hn](https://hn.cleberg.net) is a simple front-end alternative for Hacker +[hn](https://hn.cleberg.net) is a simple front-end alternative for Hacker News, focusing on privacy and simplicity. ## Getting Started -These instructions will get you a copy of the project up and running on your -local machine for development and testing purposes. See deployment for notes on +These instructions will get you a copy of the project up and running on your +local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. ### Prerequisites - A web server (e.g., Nginx or Apache) -- PHP +- PHP (>= v8.0) - Optional: minify ### Installing @@ -20,7 +20,7 @@ how to deploy the project on a live system. Install the dependencies, using the web server of your choice: ``` -sudo apt install nginx-full php minify +sudo apt install nginx-full php php-cgi php-fpm minify ``` Clone the repo: @@ -38,11 +38,11 @@ minify -o static/styles.min.css static/styles.css ## Deployment -Deployment is as easy as copying the code to your webroot. No special packages +Deployment is as easy as copying the code to your webroot. No special packages or tools required. -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` +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: @@ -55,7 +55,7 @@ location / { } ``` -For Apache, you can include the following snippet in a `.htaccess` file within +For Apache, you can include the following snippet in a `.htaccess` file within the directory you're serving the PHP file from: ```conf @@ -66,12 +66,13 @@ FallbackResource /index.php * [PHP](https://www.php.net/) - The scripting language * [HTML](https://html.spec.whatwg.org/multipage/) - The markup language -* [minify](https://github.com/tdewolff/minify/tree/master/cmd/minify) - Used to -minify CSS +* [minify](https://github.com/tdewolff/minify/tree/master/cmd/minify) - Used to + minify CSS ## Contributing -Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of +Please read [CONTRIBUTING.md](./CONTRIBUTING.md) and +[CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) for details on our code of conduct, and the process for submitting pull requests to us. ### TODO @@ -79,9 +80,10 @@ conduct, and the process for submitting pull requests to us. A scratch pad of ideas that may be useful to implement: - [x] Add minimal CSS. -- [~] Add functionality to view a user's profile. -- [ ] Add functionality to view item-specific page with comments. -- [ ] Add functionality to load more items or paginate? +- [x] Add functionality to view a user's profile. +- [ ] Add functionality to view item-specific page with comments (`ConstructStoryDiscussion`). +- [ ] Add functionality to handle polls (`ConstructPoll` & `ConstructPollOpt`). +- [ ] Add functionality to load more items or paginate. ## Versioning @@ -93,5 +95,5 @@ This project currently doesn't use versioning. See the git log instead. ## License -This project is licensed under the Unlicense - see the +This project is licensed under the Unlicense - see the [LICENSE.md](./LICENSE.md) file for details. |