https://github.com/marekzelinka/betternews

Full-Stack Hacker News Clone
https://github.com/marekzelinka/betternews

bun docker drizzle-orm flyio hackernews-clone hono postgresql tanstack-form tanstack-query tanstack-router typescript zod

Last synced: 3 days ago
JSON representation

Full-Stack Hacker News Clone

• Host: GitHub
• URL: https://github.com/marekzelinka/betternews
• Owner: marekzelinka
• Created: 2024-11-20T17:37:23.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-12-12T12:54:27.000Z (about 2 months ago)
• Last Synced: 2024-12-12T13:41:44.406Z (about 2 months ago)
• Topics: bun, docker, drizzle-orm, flyio, hackernews-clone, hono, postgresql, tanstack-form, tanstack-query, tanstack-router, typescript, zod
• Language: TypeScript
• Homepage: https://betternews-aged-wave-251.fly.dev/
• Size: 923 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# BetterNews - A Fullstack Hacker News Clone

This project is a full-stack clone of [Hacker News](https://news.ycombinator.com/), that implements the core features like posting, commenting (with nested comments), and username/password authentication. I've deployed this project on [Fly.io](https://fly.io/), but deployment with Docker is also supported.

![betternews-aged-wave-251 fly dev__sortBy=points orderBy=desc](https://github.com/user-attachments/assets/a4d61ab4-b5eb-4dff-a8a0-270f65a8989f)

## Tech Stack

- [Hono](https://hono.dev/docs/api/routing) - backend server (like Express.js, but faster)

- [Bun](https://bun.sh/) - package manager (Node.js alternative)

- [Drizzle ORM](https://orm.drizzle.team/) - database ORM library (like Prisma)

- Postgres SQL - backend database

- [Tanstack Router, Query, and Form](https://tanstack.com/) - Tanstack Query is a data management library and Tanstack Form is a form state manager

- Zod - validations

- TypeScript - static typing for JavaScript

## Usage

To use this project, you will first need a running Postgres server. You can set this up with Docker.

### Development

1. Clone the repo

2. Run `bun install`

3. Add in environment variables to `.env`

4. Run the development servers for both backend and frontend:

- `bun dev` for the backend

- `cd frontend && bun dev` for the frontend

### Production

1. Clone the repo

2. Add in environment variables to `.env`

3. Build the frontend `cd frontend && bun run build`

4. Run `bun server/index.ts`

## Goals

I've tried to implement the core features of Hacker News while creating a full-stack application.

## Credits

- [Build a HackerNews Clone](https://www.youtube.com/watch?v=eHbO5OWBBpg&t=2273s)