treehouse
/
mastodon
21
8
Fork 5
Code Issues 32 Pull Requests Projects 1 Releases Wiki Activity

update documentation
ci/woodpecker/push/woodpecker Pipeline was successful Details 

Reviewed-on: #30
Co-authored-by: fox <fox@neko.business>
Co-committed-by: fox <fox@neko.business>
pull/35/head
fox 2022-12-18 03:13:45 +00:00 committed by kouhai dev
parent aa24b2d072
commit 772ba5aac3
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
SETUP.md
View File

@ -17,31 +17,29 @@ Mastodon development requires the following:
### macOS ### macOS
First, make sure you have Homebrew installed. Follow the instructions at First, make sure you have Homebrew installed. Follow the instructions at [brew.sh](https://brew.sh).
[brew.sh](https://brew.sh).
Run the following to install all necessary packages: Run the following to install all necessary packages:
``` ```
brew install ruby@3.0 foreman node yarn postgresql redis brew install ruby@3.0 foreman node yarn postgresql redis
``` ```
Ruby 3.0 is **keg-only** by default. Follow the instructions in the **Caveat** Ruby 3.0 is **keg-only** by default. Follow the instructions in the **Caveat** to add it to your path.
to add it to your path.
### Linux ### Linux
We will assume that you know how to locate the correct packages for your distro. 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.
That said, some distros package `bundler` and `irb` separately. Make sure that
you also install these.
On Arch, you will need: On Arch, you will need:
- `ruby` - `ruby`
- `ruby-bundler` - `ruby-bundler`
- `ruby-irb` - `ruby-irb`
- `ruby-foreman` - `ruby-foreman`
- `redis` - `redis`
- `postgresql` - `postgresql`
- `yarn`
- `gmp`
- `libidn`
### Windows ### Windows
@ -80,7 +78,7 @@ mkdir -p data/redis
redis-server ./redis-dev.conf redis-server ./redis-dev.conf
# [Optional] Stop Redis # [Optional] Stop Redis
kill "$(cat ./data/redis/redis-dev.pid)" # kill "$(cat ./data/redis/redis-dev.pid)"
``` ```
## Ruby ## Ruby
@ -111,11 +109,10 @@ bundle exec rake db:setup
## Running Mastodon ## Running Mastodon
1. Run `export RAILS_ENV=development NODE_ENV=development`. 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`. 2. Run `bundle exec rake assets:precompile`.
a. If this explodes, complaining about `Hash`, you'll need to `export NODE_OPTIONS=--openssl-legacy-provider`. - 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 - After doing this, you will need to run `bundle exec rake assets:clobber` and then re-run `bundle exec rake assets:precompile`.
`bundle exec rake assets:precompile`.
3. Run `foreman start` 3. Run `foreman start`
# Updates/Troubleshooting # Updates/Troubleshooting
@ -123,21 +120,24 @@ bundle exec rake db:setup
## RubyVM/DebugInspector Issues ## 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 >_<'/. Happy to troubleshoot with someone better with Ruby than us >_<'/.
## Webpack Issues ## 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` 1. `rm -rf node_modules`
2. `yarn install` 2. `yarn install`
If this doesn't help, try: If this doesn't help, try:
1. `yarn add webpack` 1. `yarn add webpack`
2. `git restore package.json yarn.lock` 2. `git restore package.json yarn.lock`
3. `yarn install` 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.
# Need Help?
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.