forked from hexbear-collective/lemmy-hexbear
19 changed files with 199 additions and 221 deletions
-
221README.md
-
1docs/.gitignore
-
6docs/book.toml
-
17docs/src/SUMMARY.md
-
22docs/src/about.md
-
26docs/src/about_features.md
-
0docs/src/about_goals.md
-
0docs/src/about_ranking.md
-
1docs/src/administration.md
-
6docs/src/administration_configuration.md
-
11docs/src/administration_install_ansible.md
-
28docs/src/administration_install_docker.md
-
22docs/src/administration_install_kubernetes.md
-
1docs/src/contributing.md
-
0docs/src/contributing_apub_api_outline.md
-
11docs/src/contributing_docker_development.md
-
24docs/src/contributing_local_development.md
-
23docs/src/contributing_translations.md
-
0docs/src/contributing_websocket_api.md
@ -36,63 +36,6 @@ Front Page|Post |
|||
---|--- |
|||
| |
|||
|
|||
## 📝 Table of Contents |
|||
|
|||
<!-- toc --> |
|||
|
|||
- [Features](#features) |
|||
- [About](#about) |
|||
* [Why's it called Lemmy?](#whys-it-called-lemmy) |
|||
- [Install](#install) |
|||
* [Docker](#docker) |
|||
+ [Updating](#updating) |
|||
* [Ansible](#ansible) |
|||
* [Kubernetes](#kubernetes) |
|||
- [Develop](#develop) |
|||
* [Docker Development](#docker-development) |
|||
* [Local Development](#local-development) |
|||
+ [Requirements](#requirements) |
|||
+ [Set up Postgres DB](#set-up-postgres-db) |
|||
+ [Running](#running) |
|||
- [Configuration](#configuration) |
|||
- [Documentation](#documentation) |
|||
- [Support](#support) |
|||
- [Translations](#translations) |
|||
- [Credits](#credits) |
|||
|
|||
<!-- tocstop --> |
|||
|
|||
## Features |
|||
|
|||
- Open source, [AGPL License](/LICENSE). |
|||
- Self hostable, easy to deploy. |
|||
- Comes with [Docker](#docker), [Ansible](#ansible), [Kubernetes](#kubernetes). |
|||
- Clean, mobile-friendly interface. |
|||
- Live-updating Comment threads. |
|||
- Full vote scores `(+/-)` like old reddit. |
|||
- Themes, including light, dark, and solarized. |
|||
- Emojis with autocomplete support. Start typing `:` |
|||
- User tagging using `@`, Community tagging using `#`. |
|||
- Notifications, on comment replies and when you're tagged. |
|||
- i18n / internationalization support. |
|||
- RSS / Atom feeds for `All`, `Subscribed`, `Inbox`, `User`, and `Community`. |
|||
- Cross-posting support. |
|||
- A *similar post search* when creating new posts. Great for question / answer communities. |
|||
- Moderation abilities. |
|||
- Public Moderation Logs. |
|||
- Both site admins, and community moderators, who can appoint other moderators. |
|||
- Can lock, remove, and restore posts and comments. |
|||
- Can ban and unban users from communities and the site. |
|||
- Can transfer site and communities to others. |
|||
- Can fully erase your data, replacing all posts and comments. |
|||
- NSFW post / community support. |
|||
- High performance. |
|||
- Server is written in rust. |
|||
- Front end is `~80kB` gzipped. |
|||
- Supports arm64 / Raspberry Pi. |
|||
|
|||
## 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. |
|||
@ -101,144 +44,6 @@ 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 [Motörhead](https://invidio.us/watch?v=pWB5JZRGl0U). |
|||
- The old school [video game](<https://en.wikipedia.org/wiki/Lemmings_(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: |
|||
|
|||
```bash |
|||
mkdir lemmy/ |
|||
cd lemmy/ |
|||
wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml |
|||
wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/lemmy.hjson |
|||
# Edit lemmy.hjson to do more configuration |
|||
docker-compose up -d |
|||
``` |
|||
|
|||
and go to http://localhost:8536. |
|||
|
|||
[A sample nginx config](/ansible/templates/nginx.conf), could be setup with: |
|||
|
|||
```bash |
|||
wget https://raw.githubusercontent.com/dessalines/lemmy/master/ansible/templates/nginx.conf |
|||
# Replace the {{ vars }} |
|||
sudo mv nginx.conf /etc/nginx/sites-enabled/lemmy.conf |
|||
``` |
|||
#### Updating |
|||
|
|||
To update to the newest version, run: |
|||
|
|||
```bash |
|||
wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml |
|||
docker-compose up -d |
|||
``` |
|||
|
|||
### Ansible |
|||
|
|||
First, you need to [install Ansible on your local computer](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html) (e.g. using `sudo apt install ansible`) or the equivalent for you platform. |
|||
|
|||
Then run the following commands on your local computer: |
|||
|
|||
```bash |
|||
git clone https://github.com/dessalines/lemmy.git |
|||
cd lemmy/ansible/ |
|||
cp inventory.example inventory |
|||
nano inventory # enter your server, domain, contact email |
|||
ansible-playbook lemmy.yml --become |
|||
``` |
|||
|
|||
### Kubernetes |
|||
|
|||
You'll need to have an existing Kubernetes cluster and [storage class](https://kubernetes.io/docs/concepts/storage/storage-classes/). |
|||
Setting this up will vary depending on your provider. |
|||
To try it locally, you can use [MicroK8s](https://microk8s.io/) or [Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/). |
|||
|
|||
Once you have a working cluster, edit the environment variables and volume sizes in `docker/k8s/*.yml`. |
|||
You may also want to change the service types to use `LoadBalancer`s depending on where you're running your cluster (add `type: LoadBalancer` to `ports)`, or `NodePort`s. |
|||
By default they will use `ClusterIP`s, which will allow access only within the cluster. See the [docs](https://kubernetes.io/docs/concepts/services-networking/service/) for more on networking in Kubernetes. |
|||
|
|||
**Important** Running a database in Kubernetes will work, but is generally not recommended. |
|||
If you're deploying on any of the common cloud providers, you should consider using their managed database service instead (RDS, Cloud SQL, Azure Databse, etc.). |
|||
|
|||
Now you can deploy: |
|||
|
|||
```bash |
|||
# Add `-n foo` if you want to deploy into a specific namespace `foo`; |
|||
# otherwise your resources will be created in the `default` namespace. |
|||
kubectl apply -f docker/k8s/db.yml |
|||
kubectl apply -f docker/k8s/pictshare.yml |
|||
kubectl apply -f docker/k8s/lemmy.yml |
|||
``` |
|||
|
|||
If you used a `LoadBalancer`, you should see it in your cloud provider's console. |
|||
|
|||
## Develop |
|||
|
|||
### Docker Development |
|||
|
|||
Run: |
|||
|
|||
```bash |
|||
git clone https://github.com/dessalines/lemmy |
|||
cd lemmy/docker/dev |
|||
./docker_update.sh # This builds and runs it, updating for your changes |
|||
``` |
|||
|
|||
and go to 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 |
|||
|
|||
```bash |
|||
psql -c "create user lemmy with password 'password' superuser;" -U postgres |
|||
psql -c 'create database lemmy with owner lemmy;' -U postgres |
|||
export DATABASE_URL=postgres://lemmy:[email protected]:5432/lemmy |
|||
``` |
|||
|
|||
#### Running |
|||
|
|||
```bash |
|||
git clone https://github.com/dessalines/lemmy |
|||
cd lemmy |
|||
./install.sh |
|||
# 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 |
|||
``` |
|||
|
|||
## Configuration |
|||
|
|||
The configuration is based on the file [defaults.hjson](server/config/defaults.hjson). This file also contains documentation for all the available options. To override the defaults, you can copy the options you want to change into your local `config.hjson` file. |
|||
|
|||
Additionally, you can override any config files with environment variables. These have the same name as the config options, and are prefixed with `LEMMY_`. For example, you can override the `database.password` with |
|||
`LEMMY__DATABASE__POOL_SIZE=10`. |
|||
|
|||
An additional option `LEMMY_DATABASE_URL` is available, which can be used with a PostgreSQL connection string like `postgres://lemmy:[email protected]_db:5432/lemmy`, passing all connection details at once. |
|||
|
|||
## 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. |
|||
@ -249,32 +54,6 @@ Lemmy is free, open-source software, meaning no advertising, monetizing, or vent |
|||
- ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01` |
|||
- monero: `41taVyY6e1xApqKyMVDRVxJ76sPkfZhALLTjRvVKpaAh2pBd4wv9RgYj1tSPrx8wc6iE1uWUfjtQdTmTy2FGMeChGVKPQuV` |
|||
|
|||
## 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: English (`en`), Chinese (`zh`), Dutch (`nl`), Esperanto (`eo`), French (`fr`), Spanish (`es`), Swedish (`sv`), German (`de`), Russian (`ru`), Italian (`it`). |
|||
|
|||
lang | done | missing |
|||
--- | --- | --- |
|||
de | 97% | avatar,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw |
|||
eo | 84% | number_of_communities,preview,upload_image,avatar,formatting_help,view_source,sticky,unsticky,archive_link,stickied,delete_account,delete_account_confirm,banned,creator,number_online,replies,mentions,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw,theme,are_you_sure,yes,no |
|||
es | 92% | avatar,archive_link,replies,mentions,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw |
|||
fr | 92% | avatar,archive_link,replies,mentions,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw |
|||
it | 93% | avatar,archive_link,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw |
|||
nl | 86% | preview,upload_image,avatar,formatting_help,view_source,sticky,unsticky,archive_link,stickied,delete_account,delete_account_confirm,banned,creator,number_online,replies,mentions,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw,theme |
|||
ru | 80% | cross_posts,cross_post,number_of_communities,preview,upload_image,avatar,formatting_help,view_source,sticky,unsticky,archive_link,stickied,delete_account,delete_account_confirm,banned,creator,number_online,replies,mentions,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw,recent_comments,theme,monero,by,to,transfer_community,transfer_site,are_you_sure,yes,no |
|||
sv | 92% | avatar,archive_link,replies,mentions,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw |
|||
zh | 78% | cross_posts,cross_post,users,number_of_communities,preview,upload_image,avatar,formatting_help,view_source,sticky,unsticky,archive_link,settings,stickied,delete_account,delete_account_confirm,banned,creator,number_online,replies,mentions,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw,recent_comments,nsfw,show_nsfw,theme,monero,by,to,transfer_community,transfer_site,are_you_sure,yes,no |
|||
|
|||
|
|||
If you'd like to update this report, run: |
|||
|
|||
```bash |
|||
cd ui |
|||
ts-node translation_report.ts > tmp # And replace the text above. |
|||
``` |
|||
|
|||
## Credits |
|||
|
|||
Logo made by Andy Cuccaro (@andycuccaro) under the CC-BY-SA 4.0 license. |
@ -0,0 +1 @@ |
|||
book |
@ -0,0 +1,6 @@ |
|||
[book] |
|||
authors = ["Felix Ableitner"] |
|||
language = "en" |
|||
multilingual = false |
|||
src = "src" |
|||
title = "Lemmy Documentation" |
@ -0,0 +1,17 @@ |
|||
# Summary |
|||
|
|||
- [About](about.md) |
|||
- [Features](about_features.md) |
|||
- [Goals](about_goals.md) |
|||
- [Post and Comment Ranking](about_ranking.md) |
|||
- [Administration](administration.md) |
|||
- [Install with Docker](administration_install_docker.md) |
|||
- [Install with Ansible](administration_install_ansible.md) |
|||
- [Install with Kubernetes](administration_install_kubernetes.md) |
|||
- [Configuration](administration_configuration.md) |
|||
- [Contributing](contributing.md) |
|||
- [Translations](contributing_translations.md) |
|||
- [Docker Development](contributing_docker_development.md) |
|||
- [Local Development](contributing_local_development.md) |
|||
- [Websocket API](contributing_websocket_api.md) |
|||
- [ActivityPub API Outline](contributing_apub_api_outline.md) |
@ -0,0 +1,22 @@ |
|||
<p align="center">A link aggregator / reddit clone for the fediverse. |
|||
<br> |
|||
</p> |
|||
|
|||
[Lemmy Dev instance](https://dev.lemmy.ml) *for testing purposes only* |
|||
|
|||
[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. |
|||
|
|||
### Why's it called Lemmy? |
|||
|
|||
- Lead singer from [Motörhead](https://invidio.us/watch?v=pWB5JZRGl0U). |
|||
- The old school [video game](<https://en.wikipedia.org/wiki/Lemmings_(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/). |
@ -0,0 +1,26 @@ |
|||
- Open source, [AGPL License](/LICENSE). |
|||
- Self hostable, easy to deploy. |
|||
- Comes with [Docker](#docker), [Ansible](#ansible), [Kubernetes](#kubernetes). |
|||
- Clean, mobile-friendly interface. |
|||
- Live-updating Comment threads. |
|||
- Full vote scores `(+/-)` like old reddit. |
|||
- Themes, including light, dark, and solarized. |
|||
- Emojis with autocomplete support. Start typing `:` |
|||
- User tagging using `@`, Community tagging using `#`. |
|||
- Notifications, on comment replies and when you're tagged. |
|||
- i18n / internationalization support. |
|||
- RSS / Atom feeds for `All`, `Subscribed`, `Inbox`, `User`, and `Community`. |
|||
- Cross-posting support. |
|||
- A *similar post search* when creating new posts. Great for question / answer communities. |
|||
- Moderation abilities. |
|||
- Public Moderation Logs. |
|||
- Both site admins, and community moderators, who can appoint other moderators. |
|||
- Can lock, remove, and restore posts and comments. |
|||
- Can ban and unban users from communities and the site. |
|||
- Can transfer site and communities to others. |
|||
- Can fully erase your data, replacing all posts and comments. |
|||
- NSFW post / community support. |
|||
- High performance. |
|||
- Server is written in rust. |
|||
- Front end is `~80kB` gzipped. |
|||
- Supports arm64 / Raspberry Pi. |
@ -0,0 +1 @@ |
|||
Information for Lemmy instance admins, and those who want to start an instance. |
@ -0,0 +1,6 @@ |
|||
The configuration is based on the file [defaults.hjson](server/config/defaults.hjson). This file also contains documentation for all the available options. To override the defaults, you can copy the options you want to change into your local `config.hjson` file. |
|||
|
|||
Additionally, you can override any config files with environment variables. These have the same name as the config options, and are prefixed with `LEMMY_`. For example, you can override the `database.password` with |
|||
`LEMMY__DATABASE__POOL_SIZE=10`. |
|||
|
|||
An additional option `LEMMY_DATABASE_URL` is available, which can be used with a PostgreSQL connection string like `postgres://lemmy:[email protected]_db:5432/lemmy`, passing all connection details at once. |
@ -0,0 +1,11 @@ |
|||
First, you need to [install Ansible on your local computer](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html) (e.g. using `sudo apt install ansible`) or the equivalent for you platform. |
|||
|
|||
Then run the following commands on your local computer: |
|||
|
|||
```bash |
|||
git clone https://github.com/dessalines/lemmy.git |
|||
cd lemmy/ansible/ |
|||
cp inventory.example inventory |
|||
nano inventory # enter your server, domain, contact email |
|||
ansible-playbook lemmy.yml --become |
|||
``` |
@ -0,0 +1,28 @@ |
|||
Make sure you have both docker and docker-compose(>=`1.24.0`) installed: |
|||
|
|||
```bash |
|||
mkdir lemmy/ |
|||
cd lemmy/ |
|||
wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml |
|||
wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/lemmy.hjson |
|||
# Edit lemmy.hjson to do more configuration |
|||
docker-compose up -d |
|||
``` |
|||
|
|||
and go to http://localhost:8536. |
|||
|
|||
[A sample nginx config](/ansible/templates/nginx.conf), could be setup with: |
|||
|
|||
```bash |
|||
wget https://raw.githubusercontent.com/dessalines/lemmy/master/ansible/templates/nginx.conf |
|||
# Replace the {{ vars }} |
|||
sudo mv nginx.conf /etc/nginx/sites-enabled/lemmy.conf |
|||
``` |
|||
#### Updating |
|||
|
|||
To update to the newest version, run: |
|||
|
|||
```bash |
|||
wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml |
|||
docker-compose up -d |
|||
``` |
@ -0,0 +1,22 @@ |
|||
You'll need to have an existing Kubernetes cluster and [storage class](https://kubernetes.io/docs/concepts/storage/storage-classes/). |
|||
Setting this up will vary depending on your provider. |
|||
To try it locally, you can use [MicroK8s](https://microk8s.io/) or [Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/). |
|||
|
|||
Once you have a working cluster, edit the environment variables and volume sizes in `docker/k8s/*.yml`. |
|||
You may also want to change the service types to use `LoadBalancer`s depending on where you're running your cluster (add `type: LoadBalancer` to `ports)`, or `NodePort`s. |
|||
By default they will use `ClusterIP`s, which will allow access only within the cluster. See the [docs](https://kubernetes.io/docs/concepts/services-networking/service/) for more on networking in Kubernetes. |
|||
|
|||
**Important** Running a database in Kubernetes will work, but is generally not recommended. |
|||
If you're deploying on any of the common cloud providers, you should consider using their managed database service instead (RDS, Cloud SQL, Azure Databse, etc.). |
|||
|
|||
Now you can deploy: |
|||
|
|||
```bash |
|||
# Add `-n foo` if you want to deploy into a specific namespace `foo`; |
|||
# otherwise your resources will be created in the `default` namespace. |
|||
kubectl apply -f docker/k8s/db.yml |
|||
kubectl apply -f docker/k8s/pictshare.yml |
|||
kubectl apply -f docker/k8s/lemmy.yml |
|||
``` |
|||
|
|||
If you used a `LoadBalancer`, you should see it in your cloud provider's console. |
@ -0,0 +1 @@ |
|||
Information about contributing to Lemmy, whether it is translating, testing, designing or programming. |
@ -0,0 +1,11 @@ |
|||
Run: |
|||
|
|||
```bash |
|||
git clone https://github.com/dessalines/lemmy |
|||
cd lemmy/docker/dev |
|||
./docker_update.sh # This builds and runs it, updating for your changes |
|||
``` |
|||
|
|||
and go to http://localhost:8536. |
|||
|
|||
Note that compile times are relatively long with Docker, because builds can't be properly cached. If this is a problem for you, you should use [Local Development](contributing_local_development.md). |
@ -0,0 +1,24 @@ |
|||
#### Requirements |
|||
|
|||
- [Rust](https://www.rust-lang.org/) |
|||
- [Yarn](https://yarnpkg.com/en/) |
|||
- [Postgres](https://www.postgresql.org/) |
|||
|
|||
#### Set up Postgres DB |
|||
|
|||
```bash |
|||
psql -c "create user lemmy with password 'password' superuser;" -U postgres |
|||
psql -c 'create database lemmy with owner lemmy;' -U postgres |
|||
export DATABASE_URL=postgres://lemmy:[email protected]:5432/lemmy |
|||
``` |
|||
|
|||
#### Running |
|||
|
|||
```bash |
|||
git clone https://github.com/dessalines/lemmy |
|||
cd lemmy |
|||
./install.sh |
|||
# 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 |
|||
``` |
@ -0,0 +1,23 @@ |
|||
If you'd like to add translations, take a look a look at the [English translation file](ui/src/translations/en.ts). |
|||
|
|||
- Languages supported: English (`en`), Chinese (`zh`), Dutch (`nl`), Esperanto (`eo`), French (`fr`), Spanish (`es`), Swedish (`sv`), German (`de`), Russian (`ru`), Italian (`it`). |
|||
|
|||
lang | done | missing |
|||
--- | --- | --- |
|||
de | 97% | avatar,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw |
|||
eo | 84% | number_of_communities,preview,upload_image,avatar,formatting_help,view_source,sticky,unsticky,archive_link,stickied,delete_account,delete_account_confirm,banned,creator,number_online,replies,mentions,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw,theme,are_you_sure,yes,no |
|||
es | 92% | avatar,archive_link,replies,mentions,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw |
|||
fr | 92% | avatar,archive_link,replies,mentions,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw |
|||
it | 93% | avatar,archive_link,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw |
|||
nl | 86% | preview,upload_image,avatar,formatting_help,view_source,sticky,unsticky,archive_link,stickied,delete_account,delete_account_confirm,banned,creator,number_online,replies,mentions,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw,theme |
|||
ru | 80% | cross_posts,cross_post,number_of_communities,preview,upload_image,avatar,formatting_help,view_source,sticky,unsticky,archive_link,stickied,delete_account,delete_account_confirm,banned,creator,number_online,replies,mentions,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw,recent_comments,theme,monero,by,to,transfer_community,transfer_site,are_you_sure,yes,no |
|||
sv | 92% | avatar,archive_link,replies,mentions,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw |
|||
zh | 78% | cross_posts,cross_post,users,number_of_communities,preview,upload_image,avatar,formatting_help,view_source,sticky,unsticky,archive_link,settings,stickied,delete_account,delete_account_confirm,banned,creator,number_online,replies,mentions,forgot_password,reset_password_mail_sent,password_change,new_password,no_email_setup,language,browser_default,downvotes_disabled,enable_downvotes,open_registration,registration_closed,enable_nsfw,recent_comments,nsfw,show_nsfw,theme,monero,by,to,transfer_community,transfer_site,are_you_sure,yes,no |
|||
|
|||
|
|||
If you'd like to update this report, run: |
|||
|
|||
```bash |
|||
cd ui |
|||
ts-node translation_report.ts > tmp # And replace the text above. |
|||
``` |
Write
Preview
Loading…
Cancel
Save
Reference in new issue