lemmy/README.md

80 lines
3.0 KiB
Markdown
Raw Normal View History

<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
[![Build Status](https://travis-ci.org/dessalines/lemmy.svg?branch=master)](https://travis-ci.org/dessalines/lemmy)
2019-04-06 20:03:44 +00:00
[![star this repo](http://githubbadges.com/star.svg?user=dessalines&repo=lemmy&style=flat)](https://github.com/dessalines/lemmy)
[![fork this repo](http://githubbadges.com/fork.svg?user=dessalines&repo=lemmy&style=flat)](https://github.com/dessalines/lemmy/fork)
[![GitHub issues](https://img.shields.io/github/issues-raw/dessalines/lemmy.svg)](https://github.com/dessalines/lemmy/issues)
![GitHub repo size](https://img.shields.io/github/repo-size/dessalines/lemmy.svg)
[![Matrix](https://img.shields.io/matrix/rust-reddit-fediverse:matrix.org.svg?label=matrix-chat)](https://riot.im/app/#/room/#rust-reddit-fediverse:matrix.org)
[![License](https://img.shields.io/github/license/dessalines/lemmy.svg)](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-17 00:32:13 +00:00
This is a **very early beta version**, and a lot of features are currently broken or missing.
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-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-17 00:32:13 +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-06 17:19:05 +00:00
## Install
### Docker
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
docker-compose up
2019-03-30 06:08:02 +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
```
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-04-17 00:32:13 +00:00
## Support
Support the development, and help cover hosting costs.
- Patreon
- 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/)