Skip to content

Latest commit

 

History

History
58 lines (45 loc) · 1.29 KB

README.md

File metadata and controls

58 lines (45 loc) · 1.29 KB
Raw

Snowy owl emoji

Harfang

A social content posting and discussion site with a focus on simplicity and accessibility.
Inspired by Hacker News and Reddit.
Built with Django, HTMX, Alpine.js and Tailwind CSS

Features so far:

  • Posts ("Top" and "Latest" views)
  • Threaded comment system (i.e. nested comments)
  • Votes and points system for posts and comments
  • User profiles
  • Internationalization
  • Content moderation
  • Extensive tests
  • Rich link previews
  • Responsive design
  • Markdown syntax for posts
  • Dark/Light color-schemes
  • Site identity (icons, logos, etc)

Next up:

  • Public API (for bot accounts)
  • Optimized for accessibility
  • Search
  • Media Posts
  • DMs
  • SEO (django-meta)
  • Email system
  • Cookiecutter version

Dev Quick Start

"just" use the taskrunner.
Or take a look inside the justfile to see the actual commands.

# install requirements
just setup
# create mock data
just populate
# run the dev server
just runserver

Reproducible Dev Environment (optional)

Use nix via devenv to guarantee a consistent environment.
Combine with direnv for automatic shell activation.