https://github.com/sqwxl/harfang
A Hacker News clone
https://github.com/sqwxl/harfang
Last synced: about 1 month ago
JSON representation
A Hacker News clone
- Host: GitHub
- URL: https://github.com/sqwxl/harfang
- Owner: sqwxl
- Created: 2023-07-17T21:27:48.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-27T16:30:57.000Z (about 1 year ago)
- Last Synced: 2024-11-17T16:41:34.271Z (7 months ago)
- Language: JavaScript
- Size: 1.43 MB
- Stars: 4
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-python-htmx - Harfang - Django-a9bbcc?style=flat&logo=django&logoColor=black" alt="Django"></a><br/> (Projects Using PyHAT (or similar) 🏗️ / Tools <a name = "tools"></a>)
README
# 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`](https://github.com/casey/just)" use the taskrunner.\
Or take a look inside [the justfile](justfile) to see the actual commands.
```shell
# install requirements
just setup
# create mock data
just populate
# run the dev server
just runserver
```
### Reproducible Dev Environment (optional)
Use nix via [`devenv`](https://devenv.sh/getting-started/) to guarantee a
consistent environment.\
Combine with [`direnv`](https://devenv.sh/automatic-shell-activation/) for
automatic shell activation.