lemmy/README.md

3.3 KiB

Lemmy

Build Status star this repo fork this repo GitHub issues GitHub repo size Matrix License

A link aggregator / reddit clone for the fediverse.

Lemmy Dev instance for testing purposes only

This is a very early beta version, and a lot of features are currently broken or missing.

Features

  • Self hostable, easy to deploy.
    • Comes with docker.
  • Open source.
  • Live-updating Comment threads.
  • Clean, minimal interface.
    • Mobile-friendly.
  • Full vote scores (+/-) like old reddit.
  • Full moderation.
    • Both site admins, and community moderators.
    • Can lock, remove, and restore posts.
    • Can remove and restore comments.
  • High performance.
    • Server is written in rust.
    • Front end is ~80kB gzipped.

Why's it called Lemmy?

Made with Rust, Actix, Inferno, Typescript and Diesel

Install

Docker

Make sure you have both docker and docker-compose installed.

git clone https://github.com/dessalines/lemmy
cd lemmy
./docker_update.sh # This pulls the newest version, builds and runs it

and goto http://localhost:8536

Local Development

Requirements

Set up Postgres DB

 psql -c "create user rrr with password 'rrr' superuser;" -U postgres
 psql -c 'create database rrr with owner rrr;' -U postgres

Running

git clone https://github.com/dessalines/lemmy
cd lemmy
./install.sh
# For live coding, where both the front and back end, automagically reload on any save, do:
# cd ui && yarn start
# cd server && cargo watch -x run

and goto http://localhost:8536

Documentation

Support

Support the development, and help cover hosting costs.

  • Patreon
  • bitcoin: bc1queu73nwuheqtsp65nyh5hf4jr533r8rr5nsj75
  • ethereum: 0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01

Credits

Icons made by Freepik licensed by CC 3.0