Skip to content

FabianVolkers/hrefs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

519 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

hrefs

hrefs An "easily" self hostable hacker-news clone

Our main goal was to build a lightweight hacker-news clone people could use for company-internal link aggregation.

We also were using this project as a playground for trying out technologies and design ideas that we haven't tried out in the wild.

Example installation / Live deployment

The current example installation of hrefs is internal to members of the code.berlin Google Organisation and can be found at https://hrefs.withu8.com. It is filled with ~25.000 randomly generated links and ~16.000.000 votes. It is running with very limited resources inside @giesf's personal Kubernetes cluster and can display a bit of latency when the materialized views are refreshing in the background as the database has way to little cpus and ram because we did not have budget to run a production-level DB for this. We have however sucessfully tested the DB with an appropiate amount of resources.

Simplified architecture diagram

Features / Roadmap

  • OpenID Connect Integration
  • Link-sharing
  • Up & Down voting
  • Simple comments
  • Hot (top of last 7 days), new and top of all time post views
  • Custom displaynames that are seperate from the OpenID Connect Username
  • My posts view
  • Search
  • Top of the year / Top of the month views

Setting up a dev environment

We recommend using codespaces. If you are using codespaces you need to add your codespace's URL to the list of authorized redirect domains here

Backend

cd backend
# Install dependencies
yarn install
# Set up environment
cp .env.example .env
# Run DB
docker compose up db -d
# Run 
yarn run start:dev

Frontend

cd web-client
# Install dependencies
yarn install
# Set up environment
cp .env.example .env
# Run 
yarn run start:dev

Container Images

Backend Docker Container Image

Documentation

About

No description, website, or topics provided.

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors