2019-04-08 01:19:02 -04:00
< h1 > < img src = "https://image.flaticon.com/icons/svg/194/194242.svg" width = "50px" height = "50px" / > Lemmy< / h1 >
2019-02-14 12:36:53 -05:00
2019-04-06 11:32:34 -04:00
[![Build Status ](https://travis-ci.org/dessalines/lemmy.svg?branch=master )](https://travis-ci.org/dessalines/lemmy)
2019-04-06 16:03:44 -04: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 11:32:34 -04:00
2019-04-06 13:19:05 -04:00
A link aggregator / reddit clone for the fediverse.
2019-02-14 12:36:53 -05:00
2019-04-06 13:19:05 -04: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-14 20:42:04 -05:00
2019-04-06 13:19:05 -04: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 13:27:37 -05:00
2019-04-06 13:19:05 -04:00
## Features
- TBD
2019-04-08 01:19:02 -04:00
-
the name
Lead singer from motorhead.
The old school video game.
The furry rodents.
Goals r/ censorship
2019-04-06 13:19:05 -04:00
## Install
### Docker
2019-03-30 02:08:02 -04:00
```
2019-04-06 13:19:05 -04:00
git clone https://github.com/dessalines/lemmy
cd lemmy
docker-compose up
2019-03-30 02:08:02 -04:00
```
2019-04-06 19:48:54 -04:00
and goto http://localhost:8536
2019-04-06 13:19:05 -04: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-06 19:48:54 -04:00
and goto http://localhost:8536
2019-03-30 02:08:02 -04:00
2019-04-06 13:19:05 -04:00
## Documentation
2019-04-06 18:49:51 -04:00
- [ActivityPub API.md ](docs/API.md )
- [Goals ](docs/goals.md )
- [Ranking Algorithm ](docs/ranking.md )
2019-03-20 21:22:31 -04:00
2019-04-06 18:49:51 -04:00
## Credits
Icons made by [Freepik ](https://www.freepik.com/ ) licensed by [CC 3.0 ](http://creativecommons.org/licenses/by/3.0/ )