README.md

   1 <div align="center">
   2
   3 ![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/LemmyNet/lemmy.svg)
   4 [![Build Status](https://travis-ci.org/LemmyNet/lemmy.svg?branch=main)](https://travis-ci.org/LemmyNet/lemmy)
   5 [![GitHub issues](https://img.shields.io/github/issues-raw/LemmyNet/lemmy.svg)](https://github.com/LemmyNet/lemmy/issues)
   6 [![Docker Pulls](https://img.shields.io/docker/pulls/dessalines/lemmy.svg)](https://cloud.docker.com/repository/docker/dessalines/lemmy/)
   7 [![Translation status](http://weblate.yerbamate.dev/widgets/lemmy/-/lemmy/svg-badge.svg)](http://weblate.yerbamate.dev/engage/lemmy/)
   8 [![License](https://img.shields.io/github/license/LemmyNet/lemmy.svg)](LICENSE)
   9 ![GitHub stars](https://img.shields.io/github/stars/LemmyNet/lemmy?style=social)
  10 </div>
  11
  12 <p align="center">
  13   <a href="https://dev.lemmy.ml/" rel="noopener">
  14  <img width=200px height=200px src="https://raw.githubusercontent.com/LemmyNet/lemmy-ui/main/src/assets/icons/favicon.svg"></a>
  15
  16  <h3 align="center"><a href="https://dev.lemmy.ml">Lemmy</a></h3>
  17   <p align="center">
  18     A link aggregator / Reddit clone for the fediverse.
  19     <br />
  20     <br />
  21     <a href="https://dev.lemmy.ml">View Site</a>
  22     ·
  23     <a href="https://dev.lemmy.ml/docs/index.html">Documentation</a>
  24     ·
  25     <a href="https://github.com/LemmyNet/lemmy/issues">Report Bug</a>
  26     ·
  27     <a href="https://github.com/LemmyNet/lemmy/issues">Request Feature</a>
  28     ·
  29     <a href="https://github.com/LemmyNet/lemmy/blob/main/RELEASES.md">Releases</a>
  30   </p>
  31 </p>
  32
  33 ## About The Project
  34
  35 Front Page|Post
  36 ---|---
  37 ![main screen](https://raw.githubusercontent.com/LemmyNet/lemmy/main/docs/img/main_screen.png)|![chat screen](https://raw.githubusercontent.com/LemmyNet/lemmy/main/docs/img/chat_screen.png)
  38
  39 [Lemmy](https://github.com/LemmyNet/lemmy) is similar to sites like [Reddit](https://reddit.com), [Lobste.rs](https://lobste.rs), or [Hacker News](https://news.ycombinator.com/): you subscribe to forums you're interested in, post links and discussions, then vote, and comment on them. Behind the scenes, it is very different; anyone can easily run a server, and all these servers are federated (think email), and connected to the same universe, called the [Fediverse](https://en.wikipedia.org/wiki/Fediverse).
  40
  41 For a link aggregator, this means a user registered on one server can subscribe to forums on any other server, and can have discussions with users registered elsewhere.
  42
  43 The overall goal is to create an easily self-hostable, decentralized alternative to Reddit and other link aggregators, outside of their corporate control and meddling.
  44
  45 Each Lemmy server can set its own moderation policy; appointing site-wide admins, and community moderators to keep out the trolls, and foster a healthy, non-toxic environment where all can feel comfortable contributing.
  46
  47 *Note: Federation is still in active development and the WebSocket, as well as, HTTP API are currently unstable*
  48
  49 ### Why's it called Lemmy?
  50
  51 - Lead singer from [Motörhead](https://invidio.us/watch?v=pWB5JZRGl0U).
  52 - The old school [video game](<https://en.wikipedia.org/wiki/Lemmings_(video_game)>).
  53 - The [Koopa from Super Mario](https://www.mariowiki.com/Lemmy_Koopa).
  54 - The [furry rodents](http://sunchild.fpwc.org/lemming-the-little-giant-of-the-north/).
  55
  56 ### Built With
  57
  58 - [Rust](https://www.rust-lang.org)
  59 - [Actix](https://actix.rs/)
  60 - [Diesel](http://diesel.rs/)
  61 - [Inferno](https://infernojs.org)
  62 - [Typescript](https://www.typescriptlang.org/)
  63
  64 ## Features
  65
  66 - Open source, [AGPL License](/LICENSE).
  67 - Self hostable, easy to deploy.
  68   - Comes with [Docker](#docker) and [Ansible](#ansible).
  69 - Clean, mobile-friendly interface.
  70   - Only a minimum of a username and password is required to sign up!
  71   - User avatar support.
  72   - Live-updating Comment threads.
  73   - Full vote scores `(+/-)` like old Reddit.
  74   - Themes, including light, dark, and solarized.
  75   - Emojis with autocomplete support. Start typing `:`
  76   - User tagging using `@`, Community tagging using `!`.
  77   - Integrated image uploading in both posts and comments.
  78   - A post can consist of a title and any combination of self text, a URL, or nothing else.
  79   - Notifications, on comment replies and when you're tagged.
  80     - Notifications can be sent via email.
  81     - Private messaging support.
  82   - i18n / internationalization support.
  83   - RSS / Atom feeds for `All`, `Subscribed`, `Inbox`, `User`, and `Community`.
  84 - Cross-posting support.
  85   - A *similar post search* when creating new posts. Great for question / answer communities.
  86 - Moderation abilities.
  87   - Public Moderation Logs.
  88   - Can sticky posts to the top of communities.
  89   - Both site admins, and community moderators, who can appoint other moderators.
  90   - Can lock, remove, and restore posts and comments.
  91   - Can ban and unban users from communities and the site.
  92   - Can transfer site and communities to others.
  93 - Can fully erase your data, replacing all posts and comments.
  94 - NSFW post / community support.
  95 - OEmbed support via Iframely.
  96 - High performance.
  97   - Server is written in rust.
  98   - Front end is `~80kB` gzipped.
  99   - Supports arm64 / Raspberry Pi.
 100
 101 ## Installation
 102
 103 - [Docker](https://dev.lemmy.ml/docs/administration_install_docker.html)
 104 - [Ansible](https://dev.lemmy.ml/docs/administration_install_ansible.html)
 105
 106 ## Lemmy Projects
 107
 108 ### Apps
 109
 110 - [lemmy-ui - The official web app for lemmy](https://github.com/LemmyNet/lemmy-ui)
 111 - [Lemmur - A flutter lemmy app ( under development )](https://github.com/krawieck/lemmur)
 112 - [Lemmy-mobile (Android / IOS) - React native ( under development )](https://github.com/koredefashokun/lemmy-mobile)
 113
 114 ### Libraries
 115
 116 - [lemmy-js-client](https://github.com/LemmyNet/lemmy-js-client)
 117 - [Kotlin API ( under development )](https://github.com/eiknat/lemmy-client)
 118 - [Dart API client ( under development )](https://github.com/krawieck/lemmy_api_client)
 119
 120 ## Support / Donate
 121
 122 Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project.
 123
 124 - [Support on Liberapay](https://liberapay.com/Lemmy).
 125 - [Support on Patreon](https://www.patreon.com/dessalines).
 126 - [Support on OpenCollective](https://opencollective.com/lemmy).
 127 - [List of Sponsors](https://dev.lemmy.ml/sponsors).
 128
 129 ### Crypto
 130
 131 - bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK`
 132 - ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01`
 133 - monero: `41taVyY6e1xApqKyMVDRVxJ76sPkfZhALLTjRvVKpaAh2pBd4wv9RgYj1tSPrx8wc6iE1uWUfjtQdTmTy2FGMeChGVKPQuV`
 134
 135 ## Contributing
 136
 137 - [Contributing instructions](https://dev.lemmy.ml/docs/contributing.html)
 138 - [Docker Development](https://dev.lemmy.ml/docs/contributing_docker_development.html)
 139 - [Local Development](https://dev.lemmy.ml/docs/contributing_local_development.html)
 140
 141 ### Translations
 142
 143 If you want to help with translating, take a look at [Weblate](https://weblate.yerbamate.dev/projects/lemmy/).
 144
 145 ## Contact
 146
 147 - [Mastodon](https://mastodon.social/@LemmyDev)
 148 - [Matrix](https://riot.im/app/#/room/#rust-reddit-fediverse:matrix.org)
 149
 150 ## Code Mirrors
 151
 152 - [GitHub](https://github.com/LemmyNet/lemmy)
 153 - [Gitea](https://yerbamate.dev/LemmyNet/lemmy)
 154 - [Codeberg](https://codeberg.org/LemmyNet/lemmy)
 155
 156 ## Credits
 157
 158 Logo made by Andy Cuccaro (@andycuccaro) under the CC-BY-SA 4.0 license.