Skip to content

Commit

Permalink
Updated README.md and add LICENSE
Browse files Browse the repository at this point in the history
  • Loading branch information
joeychilson committed Dec 21, 2023
1 parent b86f1ef commit e7c5fe4
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 10 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Joey Chilson

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,38 @@
# hackernews

This project is aimed at recreating the popular Hacker News using Go and the templ library.
A Hacker News clone built with [Go](https://go.dev/), [templ](https://github.com/a-h/templ), and [Tailwind](https://tailwindcss.com/)

It's designed to closely mirror the functionality of hacker news as much with the limitations of the public API.
<p align="center">
<img width="1080" src="https://hckrnws.fly.dev/assets/home_page.png">
<img width="1080" src="https://hckrnws.fly.dev/assets/thread.png">
</p>

The application is a close drop-in replacement for the actual hacker news application with the limitations of the API.
## Demo

You can just replace the hacker news url https://news.ycombinator.com/ with the url https://hckrnws.fly.dev/.
https://hckrnws.fly.dev/news

Reply links will redirect to the actual hacker news website.
## Features

### requirements
- No JS required

#### install tailwind cli
## Build Setup

#### Install tailwind cli
```bash
brew install tailwindcss
```

#### install templ
#### Install templ
```bash
go install github.com/a-h/templ/cmd/templ@latest
```

#### run dev
#### Build and run server
```bash
make dev
```

#### deploy
#### Deploy to [Fly](https://fly.io)
```bash
fly launch
```
Binary file added assets/home_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/thread.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e7c5fe4

Please sign in to comment.