mirror of
https://github.com/LemmyNet/lemmy.git
synced 2024-05-18 09:52:40 +00:00
5c6258390c
* Adding a way to GetComments for a community given its name only. * Adding getcomments to api docs. * A first pass at locally working isomorphic integration. * Testing out cargo-husky. * Testing a fail hook. * Revert "Testing a fail hook." This reverts commit0941cf1736. * Moving server to top level, now that UI is gone. * Running cargo fmt using old way. * Adding nginx, fixing up docker-compose files, fixing docs. * Trying to re-add API tests. * Fixing prod dockerfile. * Redoing nightly fmt * Trying to fix private message api test. * Adding CommunityJoin, PostJoin instead of joins from GetComments, etc. - Fixes #1122 * Fixing fmt. * Fixing up docs. * Removing translations. * Adding apps / clients to readme. * Fixing main image. * Using new lemmy-isomorphic-ui with better javascript disabled. * Try to fix image uploads in federation test * Revert "Try to fix image uploads in federation test" This reverts commita2ddf2a90b. * Fix post url federation * Adding some more tests, some still broken. * Don't need gitattributes anymore. * Update local federation test setup * Fixing tests. * Fixing travis build. * Fixing travis build, again. * Changing lemmy-isomorphic-ui to lemmy-ui * Error in travis build again. Co-authored-by: Felix Ableitner <me@nutomic.com>
86 lines
2.4 KiB
Markdown
86 lines
2.4 KiB
Markdown
### 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).
|
|
|
|
Then, install [Homebrew](https://brew.sh/) if you don't already have it installed.
|
|
|
|
Finally, install Node and Yarn.
|
|
|
|
```
|
|
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
|
|
```
|
|
|
|
### 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
|
|
|
|
# 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
|
|
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).
|