From e4fab8a56c65ea3909bd67c6dce8a192d5feaf60 Mon Sep 17 00:00:00 2001 From: fox Date: Thu, 8 Dec 2022 23:22:56 -0600 Subject: [PATCH 1/7] nest bullets --- SETUP.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/SETUP.md b/SETUP.md index d09de77b24..90bdb3a285 100644 --- a/SETUP.md +++ b/SETUP.md @@ -111,10 +111,10 @@ bundle exec rake db:setup ## Running Mastodon 1. Run `export RAILS_ENV=development NODE_ENV=development`. - a. Put these in your shell's .rc, or a script you can source if you want to skip this step in the future. + - Put these in your shell's .rc, or a script you can source if you want to skip this step in the future. 2. Run `bundle exec rake assets:precompile`. - a. If this explodes, complaining about `Hash`, you'll need to `export NODE_OPTIONS=--openssl-legacy-provider`. - b. After doing this, you will need to run `bundle exec rake assets:clobber` and then re-run + - If this explodes, complaining about `Hash`, you'll need to `export NODE_OPTIONS=--openssl-legacy-provider`. + - After doing this, you will need to run `bundle exec rake assets:clobber` and then re-run `bundle exec rake assets:precompile`. 3. Run `foreman start` -- 2.41.0 From 97333269fe542702f65e6ac8f1e40aeccfe89d07 Mon Sep 17 00:00:00 2001 From: fox Date: Thu, 8 Dec 2022 23:30:49 -0600 Subject: [PATCH 2/7] comment out optional commands --- SETUP.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SETUP.md b/SETUP.md index 90bdb3a285..a007c7213b 100644 --- a/SETUP.md +++ b/SETUP.md @@ -80,7 +80,7 @@ mkdir -p data/redis redis-server ./redis-dev.conf # [Optional] Stop Redis -kill "$(cat ./data/redis/redis-dev.pid)" +# kill "$(cat ./data/redis/redis-dev.pid)" ``` ## Ruby -- 2.41.0 From c6b1e20fa32a43d3c994649f73baaaceaefcded8 Mon Sep 17 00:00:00 2001 From: fox Date: Fri, 9 Dec 2022 19:34:43 -0600 Subject: [PATCH 3/7] add missing packages --- SETUP.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/SETUP.md b/SETUP.md index a007c7213b..1fb3322855 100644 --- a/SETUP.md +++ b/SETUP.md @@ -42,6 +42,9 @@ On Arch, you will need: - `ruby-foreman` - `redis` - `postgresql` +- `yarn` +- `gmp` +- `libidn` ### Windows -- 2.41.0 From 7662bce6fa783bba1f9d0b339236b58e61f72655 Mon Sep 17 00:00:00 2001 From: fox Date: Fri, 9 Dec 2022 22:20:15 -0600 Subject: [PATCH 4/7] format spacing and 80 character limit --- SETUP.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/SETUP.md b/SETUP.md index 1fb3322855..a9cc7c8dfe 100644 --- a/SETUP.md +++ b/SETUP.md @@ -114,33 +114,38 @@ bundle exec rake db:setup ## Running Mastodon 1. Run `export RAILS_ENV=development NODE_ENV=development`. - - Put these in your shell's .rc, or a script you can source if you want to skip this step in the future. + - Put these in your shell's .rc, or a script you can source if you want to \ + skip this step in the future. 2. Run `bundle exec rake assets:precompile`. - - If this explodes, complaining about `Hash`, you'll need to `export NODE_OPTIONS=--openssl-legacy-provider`. - - After doing this, you will need to run `bundle exec rake assets:clobber` and then re-run - `bundle exec rake assets:precompile`. + - If this explodes, complaining about `Hash`, you'll need to \ + `export NODE_OPTIONS=--openssl-legacy-provider`. + - After doing this, you will need to run `bundle exec rake assets:clobber` \ + and then re-run `bundle exec rake assets:precompile`. 3. Run `foreman start` # Updates/Troubleshooting ## RubyVM/DebugInspector Issues -Still unable to fix. Circumvent by removing `better_errors` and `binding_of_caller` from Gemfile. +Still unable to fix. Circumvent by removing `better_errors` and +`binding_of_caller` from Gemfile. + Happy to troubleshoot with someone better with Ruby than us >_<'/. ## Webpack Issues -If Webpack compalins about being unable to find some assets or locales: -Try: +If Webpack compalins about being unable to find some assets or locales: + +Try: 1. `rm -rf node_modules` 2. `yarn install` If this doesn't help, try: - 1. `yarn add webpack` 2. `git restore package.json yarn.lock` 3. `yarn install` Then re-run `foreman`. No. We have no idea why this worked. -If the above instructions don't work, please contact @Rin here, or @tammy@social.treehouse.systems. +If the above instructions don't work, please contact @Rin here, or \ +@tammy@social.treehouse.systems. -- 2.41.0 From 977e165b2818bda77bead7c1e4460f309370c261 Mon Sep 17 00:00:00 2001 From: fox Date: Fri, 9 Dec 2022 22:22:57 -0600 Subject: [PATCH 5/7] foreman command --- SETUP.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SETUP.md b/SETUP.md index a9cc7c8dfe..637ab7e3ba 100644 --- a/SETUP.md +++ b/SETUP.md @@ -145,7 +145,7 @@ If this doesn't help, try: 2. `git restore package.json yarn.lock` 3. `yarn install` -Then re-run `foreman`. No. We have no idea why this worked. +Then re-run `foreman start`. No. We have no idea why this worked. If the above instructions don't work, please contact @Rin here, or \ @tammy@social.treehouse.systems. -- 2.41.0 From fa0ad184c9accee4478613fd0baf162a8757fe80 Mon Sep 17 00:00:00 2001 From: fox Date: Fri, 9 Dec 2022 23:01:29 -0600 Subject: [PATCH 6/7] remove 80 character line limit --- SETUP.md | 26 ++++++++------------------ 1 file changed, 8 insertions(+), 18 deletions(-) diff --git a/SETUP.md b/SETUP.md index 637ab7e3ba..c5ea9ac0c4 100644 --- a/SETUP.md +++ b/SETUP.md @@ -17,25 +17,20 @@ Mastodon development requires the following: ### macOS -First, make sure you have Homebrew installed. Follow the instructions at -[brew.sh](https://brew.sh). +First, make sure you have Homebrew installed. Follow the instructions at [brew.sh](https://brew.sh). Run the following to install all necessary packages: ``` brew install ruby@3.0 foreman node yarn postgresql redis ``` -Ruby 3.0 is **keg-only** by default. Follow the instructions in the **Caveat** -to add it to your path. +Ruby 3.0 is **keg-only** by default. Follow the instructions in the **Caveat** to add it to your path. ### Linux -We will assume that you know how to locate the correct packages for your distro. -That said, some distros package `bundler` and `irb` separately. Make sure that -you also install these. +We will assume that you know how to locate the correct packages for your distro. That said, some distros package `bundler` and `irb` separately. Make sure that you also install these. On Arch, you will need: - - `ruby` - `ruby-bundler` - `ruby-irb` @@ -114,21 +109,17 @@ bundle exec rake db:setup ## Running Mastodon 1. Run `export RAILS_ENV=development NODE_ENV=development`. - - Put these in your shell's .rc, or a script you can source if you want to \ - skip this step in the future. + - Put these in your shell's .rc, or a script you can source if you want to skip this step in the future. 2. Run `bundle exec rake assets:precompile`. - - If this explodes, complaining about `Hash`, you'll need to \ - `export NODE_OPTIONS=--openssl-legacy-provider`. - - After doing this, you will need to run `bundle exec rake assets:clobber` \ - and then re-run `bundle exec rake assets:precompile`. + - If this explodes, complaining about `Hash`, you'll need to `export NODE_OPTIONS=--openssl-legacy-provider`. + - After doing this, you will need to run `bundle exec rake assets:clobber` and then re-run `bundle exec rake assets:precompile`. 3. Run `foreman start` # Updates/Troubleshooting ## RubyVM/DebugInspector Issues -Still unable to fix. Circumvent by removing `better_errors` and -`binding_of_caller` from Gemfile. +Still unable to fix. Circumvent by removing `better_errors` and `binding_of_caller` from Gemfile. Happy to troubleshoot with someone better with Ruby than us >_<'/. @@ -147,5 +138,4 @@ If this doesn't help, try: Then re-run `foreman start`. No. We have no idea why this worked. -If the above instructions don't work, please contact @Rin here, or \ -@tammy@social.treehouse.systems. +If the above instructions don't work, please contact @Rin here, or @tammy@social.treehouse.systems. -- 2.41.0 From 493ac414e459e1693b52e0aa0796390d7383f778 Mon Sep 17 00:00:00 2001 From: fox Date: Fri, 9 Dec 2022 23:02:18 -0600 Subject: [PATCH 7/7] add "Need Help" header --- SETUP.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/SETUP.md b/SETUP.md index c5ea9ac0c4..716048a2b1 100644 --- a/SETUP.md +++ b/SETUP.md @@ -138,4 +138,6 @@ If this doesn't help, try: Then re-run `foreman start`. No. We have no idea why this worked. +# Need Help? + If the above instructions don't work, please contact @Rin here, or @tammy@social.treehouse.systems. -- 2.41.0