diff --git a/README.md b/README.md index 07f2426d2..ed21cfe3d 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ Front Page|Post ---|--- ![main screen](https://i.imgur.com/y64BtXC.png)|![chat screen](https://i.imgur.com/vsOr87q.png) ## Features + - Open source, [AGPL License](/LICENSE). - Self hostable, easy to deploy. - Comes with [Docker](#docker). @@ -38,7 +39,9 @@ Front Page|Post - High performance. - Server is written in rust. - Front end is `~80kB` gzipped. + ## About + [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. @@ -48,14 +51,18 @@ The overall goal is to create an easily self-hostable, decentralized alternative 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. ## Why's it called Lemmy? + - Lead singer from [motorhead](https://invidio.us/watch?v=pWB5JZRGl0U). - The old school [video game](). - The [Koopa from Super Mario](https://www.mariowiki.com/Lemmy_Koopa). - The [furry rodents](http://sunchild.fpwc.org/lemming-the-little-giant-of-the-north/). 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/). + ## Install + ### Docker + Make sure you have both docker and docker-compose(>=`1.24.0`) installed. ``` @@ -83,7 +90,9 @@ location / { ``` ## Develop + ### Docker Development + ``` git clone https://github.com/dessalines/lemmy cd lemmy @@ -91,17 +100,24 @@ cd lemmy ``` and goto http://localhost:8536 + ### Local Development + #### Requirements + - [Rust](https://www.rust-lang.org/) - [Yarn](https://yarnpkg.com/en/) - [Postgres](https://www.postgresql.org/) + #### 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 @@ -112,15 +128,26 @@ cd lemmy ``` ## Documentation + - [Websocket API for App developers](docs/api.md) - [ActivityPub API.md](docs/apub_api_outline.md) - [Goals](docs/goals.md) - [Ranking Algorithm](docs/ranking.md) + ## Support + Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project. - [Support on Patreon](https://www.patreon.com/dessalines). - [Sponsor List](https://dev.lemmy.ml/sponsors). - bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK` - ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01` + +## Translations + +If you'd like to add translations, take a look a look at the [english translation file](ui/src/translations/en.ts). + +- Languages supported so far: `en`. + ## Credits + Icons made by [Freepik](https://www.freepik.com/) licensed by [CC 3.0](http://creativecommons.org/licenses/by/3.0/)