2019-04-06 05:29:20 +00:00
# Lemmy
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 17:19:05 +00:00
A link aggregator / reddit clone for the fediverse.
2019-02-14 17:36:53 +00:00
2019-04-06 17:19:05 +00:00
Made with [Rust ](https://www.rust-lang.org ), [Actix ](https://actix.rs/ ), [Inferno ](https://www.infernojs.org ), [Typescript ](https://www.typescriptlang.org/ ).
2019-02-15 01:42:04 +00:00
2019-04-06 17:19:05 +00:00
## Navigation
- [Matrix Chatroom ](https://riot.im/app/#/room/#rust-reddit-fediverse:matrix.org )
- [Issues / Feature Requests ](https://github.com/dessalines/lemmy/issues )
- Support the development via Patreon
2019-02-15 18:27:37 +00:00
2019-04-06 17:19:05 +00:00
## Features
- TBD
## 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
```
2019-04-06 17:19:05 +00:00
and goto http://localhost:8080
### 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:8080
2019-03-30 06:08:02 +00:00
2019-04-06 17:19:05 +00:00
## Documentation
- [ActivityPub API.md ](API.md )
- [Goals ](goals.md )
- [Ranking Algorithm ](ranking.md )
2019-03-21 01:22:31 +00:00