2019-04-08 05:19:02 +00:00
< h1 > < img src = "https://image.flaticon.com/icons/svg/194/194242.svg" width = "50px" height = "50px" / > Lemmy< / h1 >
2019-02-14 17:36:53 +00:00
2019-04-06 15:32:34 +00:00
[](https://travis-ci.org/dessalines/lemmy)
2019-04-06 20:03:44 +00:00
[](https://github.com/dessalines/lemmy)
[](https://github.com/dessalines/lemmy/fork)
[](https://github.com/dessalines/lemmy/issues)
[](https://riot.im/app/#/room/#rust-reddit-fediverse:matrix.org)
2019-04-22 20:35:51 +00:00
[](https://www.patreon.com/dessalines)
2019-04-06 20:03:44 +00:00
[](LICENSE)
2019-04-06 15:32:34 +00:00
2019-04-06 17:19:05 +00:00
A link aggregator / reddit clone for the fediverse.
2019-02-14 17:36:53 +00:00
2019-04-17 00:32:13 +00:00
[Lemmy Dev instance ](https://dev.lemmy.ml ) *for testing purposes only*
2019-02-15 01:42:04 +00:00
2019-04-22 20:35:51 +00:00
This is a **very early beta version** , and a lot of features are currently broken or in active development, such as federation.
2019-02-15 18:27:37 +00:00
2019-04-06 17:19:05 +00:00
## Features
2019-04-17 00:32:13 +00:00
- 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.
2019-04-08 05:19:02 +00:00
2019-04-21 17:15:40 +00:00
## About
2019-04-22 20:35:51 +00:00
[Lemmy ](https://github.com/dessalines/lemmy ) is similar to sites like [Reddit ](https://reddit.com ), [lobste.rs ](https://lobste.rs ), [Raddle ](https://raddle.me ), 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 ).
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.
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.
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.
2019-04-21 17:15:40 +00:00
2019-04-16 23:04:23 +00:00
## Why's it called Lemmy?
- Lead singer from [motorhead ](https://invidio.us/watch?v=pWB5JZRGl0U ).
- The old school [video game ](https://en.wikipedia.org/wiki/Lemmings_(video_game )).
- The [furry rodents ](http://sunchild.fpwc.org/lemming-the-little-giant-of-the-north/ ).
2019-04-08 05:19:02 +00:00
2019-04-22 20:35:51 +00:00
Made with [Rust ](https://www.rust-lang.org ), [Actix ](https://actix.rs/ ), [Inferno ](https://www.infernojs.org ), [Typescript ](https://www.typescriptlang.org/ ) and [Diesel ](http://diesel.rs/ ).
2019-04-08 05:19:02 +00:00
2019-04-06 17:19:05 +00:00
## Install
### Docker
2019-04-18 14:45:05 +00:00
Make sure you have both docker and docker-compose installed.
2019-03-30 06:08:02 +00:00
```
2019-04-06 17:19:05 +00:00
git clone https://github.com/dessalines/lemmy
cd lemmy
2019-04-18 14:45:05 +00:00
./docker_update.sh # This pulls the newest version, builds and runs it
2019-03-30 06:08:02 +00:00
```
2019-04-06 23:48:54 +00:00
and goto http://localhost:8536
2019-04-06 17:19:05 +00:00
### Local Development
#### Requirements
- [Rust ](https://www.rust-lang.org/ )
- [Yarn ](https://yarnpkg.com/en/ )
- [Postgres ](https://www.sqlite.org/index.html )
#### 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
2019-04-18 16:24:24 +00:00
# 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
2019-04-06 17:19:05 +00:00
```
2019-04-06 23:48:54 +00:00
and goto http://localhost:8536
2019-03-30 06:08:02 +00:00
2019-04-06 17:19:05 +00:00
## Documentation
2019-04-06 22:49:51 +00:00
- [ActivityPub API.md ](docs/API.md )
- [Goals ](docs/goals.md )
- [Ranking Algorithm ](docs/ranking.md )
2019-03-21 01:22:31 +00:00
2019-04-17 00:32:13 +00:00
## Support
Support the development, and help cover hosting costs.
2019-04-22 20:35:51 +00:00
- [Patreon ](https://www.patreon.com/dessalines )
2019-04-17 00:32:13 +00:00
- bitcoin: `bc1queu73nwuheqtsp65nyh5hf4jr533r8rr5nsj75`
- ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01`
2019-04-06 22:49:51 +00:00
## Credits
Icons made by [Freepik ](https://www.freepik.com/ ) licensed by [CC 3.0 ](http://creativecommons.org/licenses/by/3.0/ )
