docs/src/contributing.md

   1 # Contributing
   2
   3 Information about contributing to Lemmy, whether it is translating, testing, designing or programming.
   4
   5 ## Issue tracking / Repositories
   6
   7 - [GitHub (for issues)](https://github.com/dessalines/lemmy)
   8 - [Gitea](https://yerbamate.dev/dessalines/lemmy)
   9 - [GitLab](https://gitlab.com/dessalines/lemmy)
  10
  11 ## Translating
  12
  13 Go [here](https://github.com/dessalines/lemmy#translations) for translation instructions.
  14
  15 ## Architecture
  16
  17 ### Front end
  18
  19 - The front end is written in `typescript`, using a react-like framework called [inferno](https://infernojs.org/). All UI elements are reusable `.tsx` components.
  20 - The main page and routing are in `ui/src/index.tsx`.
  21 - The components are located in `ui/src/components`.
  22
  23 ### Back end
  24
  25 - The back end is written in `rust`, using `diesel`, and `actix`.
  26 - The server source code is split into main sections in `server/src`. These include:
  27   - `db` - The low level database actions.
  28     - Database additions are done using diesel migrations. Run `diesel migration generate xxxxx` to add new things.
  29   - `api` - The high level user interactions (things like `CreateComment`)
  30   - `routes` - The server endpoints .
  31   - `apub` - The activitypub conversions.
  32   - `websocket` - Creates the websocket server.
  33
  34 ## Linting / Formatting
  35
  36 - Every front and back end commit is automatically formatted then linted using `husky`, and `lint-staged`.
  37 - Rust with `cargo fmt` and `cargo clippy`.
  38 - Typescript with `prettier` and `eslint`.