Isomorphic docker (#1124)

[lemmy.git] / docs / src / contributing_local_development.md

diff --git a/docs/src/contributing_local_development.md b/docs/src/contributing_local_development.md
index c19bcba843cd19bd6e2b10c18de5d2e560e59516..5f53d3374a126d99059a224ba78ffcf1a3fcbe50 100644 (file)
--- a/docs/src/contributing_local_development.md
+++ b/docs/src/contributing_local_development.md
@@ -1,24 +1,85 @@
-#### Requirements
+### Install build requirements
+#### Ubuntu
+```
+sudo apt install git cargo libssl-dev pkg-config libpq-dev yarn curl gnupg2 espeak
+# install yarn
+curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
+echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
+sudo apt update && sudo apt install yarn
+```
+
+#### macOS
+
+Install Rust using [the recommended option on rust-lang.org](https://www.rust-lang.org/tools/install) (rustup).
 
-- [Rust](https://www.rust-lang.org/)
-- [Yarn](https://yarnpkg.com/en/)
-- [Postgres](https://www.postgresql.org/)
+Then, install [Homebrew](https://brew.sh/) if you don't already have it installed.
 
-#### Set up Postgres DB
+Finally, install Node and Yarn.
 
-```bash
- psql -c "create user lemmy with password 'password' superuser;" -U postgres
- psql -c 'create database lemmy with owner lemmy;' -U postgres
- export LEMMY_DATABASE_URL=postgres://lemmy:password@localhost:5432/lemmy
+```
+brew install node yarn
+```
+
+### Get the back end source code
+```
+git clone https://github.com/LemmyNet/lemmy.git
+# or alternatively from gitea
+# git clone https://yerbamate.dev/LemmyNet/lemmy.git
 ```
 
-#### Running
+### Build the backend (Rust)
+```
+cargo build
+# for development, use `cargo check` instead)
+```
+
+### Get the front end source code
+```
+git clone https://github.com/LemmyNet/lemmy-ui.git
+```
+
+### Setup postgresql
+#### Ubuntu
+```
+sudo apt install postgresql
+sudo systemctl start postgresql
 
-```bash
-git clone https://github.com/dessalines/lemmy
+# Either execute db-init.sh, or manually initialize the postgres database:
+sudo -u postgres psql -c "create user lemmy with password 'password' superuser;" -U postgres
+sudo -u postgres psql -c 'create database lemmy with owner lemmy;' -U postgres
+export LEMMY_DATABASE_URL=postgres://lemmy:password@localhost:5432/lemmy
+```
+
+#### macOS
+```
+brew install postgresql
+brew services start postgresql
+/usr/local/opt/postgres/bin/createuser -s postgres
+
+# Either execute db-init.sh, or manually initialize the postgres database:
+psql -c "create user lemmy with password 'password' superuser;" -U postgres
+psql -c 'create database lemmy with owner lemmy;' -U postgres
+export LEMMY_DATABASE_URL=postgres://lemmy:password@localhost:5432/lemmy
+```
+
+### Run a local development instance
+```
 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
+cargo run
 ```
+
+Then open [localhost:1235](http://localhost:1235) in your browser. To reload back-end changes, you will have to rerun `cargo run`. You can use `cargo check` as a faster way to find compilation errors.
+
+To do front end development:
+
+```
+cd lemmy-ui
+yarn
+yarn dev
+```
+
+and goto [localhost:1234](http://localhost:1234). Front end saves should rebuild the project.
+
+Note that this setup doesn't include image uploads or link previews (provided by pict-rs and
+iframely respectively). If you want to test those, you should use the
+[Docker development](contributing_docker_development.md).