2022-11-21 06:43:06 +00:00
# Setting up a dev environment
2022-11-25 00:57:24 +00:00
## Prerequisites
2022-11-21 06:43:06 +00:00
2022-11-25 00:57:24 +00:00
Mastodon development requires the following:
2022-11-21 06:43:06 +00:00
2022-11-25 00:57:24 +00:00
- Ruby 3.0
- Ruby gems:
- `bundler`
- `irb`
- `foreman`
- NodeJS v18 (LTS)
- NPM packages:
- `yarn`
- Postgres
- Redis
### macOS
2022-12-18 03:13:45 +00:00
First, make sure you have Homebrew installed. Follow the instructions at [brew.sh ](https://brew.sh ).
2022-11-25 00:57:24 +00:00
Run the following to install all necessary packages:
```
brew install ruby@3.0 foreman node yarn postgresql redis
```
2022-12-18 03:13:45 +00:00
Ruby 3.0 is **keg-only** by default. Follow the instructions in the **Caveat** to add it to your path.
2022-11-25 00:57:24 +00:00
### Linux
2022-11-21 06:43:06 +00:00
2022-12-18 03:13:45 +00:00
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.
2022-11-21 06:43:06 +00:00
2022-11-25 00:57:24 +00:00
On Arch, you will need:
- `ruby`
- `ruby-bundler`
- `ruby-irb`
- `ruby-foreman`
2022-11-25 03:24:44 +00:00
- `redis`
- `postgresql`
2022-12-18 03:13:45 +00:00
- `yarn`
- `gmp`
- `libidn`
2022-11-21 06:43:06 +00:00
2022-11-25 00:57:24 +00:00
### Windows
2022-11-21 06:43:06 +00:00
2022-11-25 00:57:24 +00:00
Unfortunately, none of the authors use Windows. Contributions welcome!
2022-11-21 06:43:06 +00:00
2022-11-25 00:57:24 +00:00
## Database
2022-11-21 06:43:06 +00:00
2022-11-25 00:57:24 +00:00
In the root of this repository, go through the following script:
```sh
# Create a folder for local data
mkdir -p data
2022-11-21 06:43:06 +00:00
2022-11-25 00:57:24 +00:00
# Set up a local database
pg_ctl -D data/postgres initdb -o '-U mastodon --auth-host=trust'
2022-11-21 06:43:06 +00:00
2022-11-25 00:57:24 +00:00
# Use the data/postgres folder for the DB connection unix socket
#
# If you don't know what that means, it's just a way for Mastodon to communicate
# with a database on the same machine efficiently.
#
# See: https://manpages.ubuntu.com/manpages/jammy/man7/unix.7.html
echo 'unix_socket_directories = .' >> data/postgres/postgresql.conf
2022-11-21 06:43:06 +00:00
2022-11-25 00:57:24 +00:00
# Start the database
pg_ctl -D data/postgres start --silent
```
2022-11-21 06:43:06 +00:00
2022-11-25 00:57:24 +00:00
## Redis
2022-11-21 06:43:06 +00:00
2022-11-25 00:57:24 +00:00
In the root of this repository, run the following:
```sh
2022-11-25 03:24:44 +00:00
# Create a folder for redis data
mkdir -p data/redis
2022-11-25 00:57:24 +00:00
# Start Redis
redis-server ./redis-dev.conf
2022-11-21 06:43:06 +00:00
2022-11-25 00:57:24 +00:00
# [Optional] Stop Redis
2022-12-18 03:13:45 +00:00
# kill "$(cat ./data/redis/redis-dev.pid)"
2022-11-25 00:57:24 +00:00
```
2022-11-21 06:43:06 +00:00
2022-11-25 00:57:24 +00:00
## Ruby
```sh
export RAILS_ENV=development
# Bundle installs all Ruby gems globally by default, which might cause problems.
bundle config set --local path 'vendor/bundle'
# [Apple Silicon] If using macOS on Apple Silicon, run the following:
# bundle config build.idn-ruby -- --with-idn-dir="$(brew --prefix libidn)"
# Install dependencies using bundle (Ruby) and yarn (JS)
bundle install
yarn install
# Setup the database using the pre-defined Rake task
#
# Rake is a command runner for Ruby projects. The `bundle exec` ensures that
# we use the version of Rake that this project requires.
bundle exec rake db:setup
# [Optional] If that fails, run the following and try again:
# bundle exec rake db:reset
```
2022-11-21 06:43:06 +00:00
2022-11-21 10:06:35 +00:00
## Running Mastodon
2022-11-21 06:43:06 +00:00
2022-11-25 00:57:24 +00:00
1. Run `export RAILS_ENV=development NODE_ENV=development` .
2022-12-18 03:13:45 +00:00
- Put these in your shell's .rc, or a script you can source if you want to skip this step in the future.
2022-11-25 00:57:24 +00:00
2. Run `bundle exec rake assets:precompile` .
2022-12-18 03:13:45 +00:00
- 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` .
2022-11-25 00:57:24 +00:00
3. Run `foreman start`
2022-11-21 06:43:06 +00:00
# Updates/Troubleshooting
## RubyVM/DebugInspector Issues
2022-11-21 08:31:46 +00:00
Still unable to fix. Circumvent by removing `better_errors` and `binding_of_caller` from Gemfile.
2022-12-18 03:13:45 +00:00
2022-11-21 06:43:06 +00:00
Happy to troubleshoot with someone better with Ruby than us >_< '/.
## Webpack Issues
2022-12-18 03:13:45 +00:00
2022-11-21 06:43:06 +00:00
If Webpack compalins about being unable to find some assets or locales:
2022-11-23 08:31:10 +00:00
2022-12-18 03:13:45 +00:00
Try:
2022-11-23 08:31:10 +00:00
1. `rm -rf node_modules`
2. `yarn install`
If this doesn't help, try:
2022-11-23 08:35:13 +00:00
1. `yarn add webpack`
2. `git restore package.json yarn.lock`
3. `yarn install`
2022-11-21 06:43:06 +00:00
2022-12-18 03:13:45 +00:00
Then re-run `foreman start` . No. We have no idea why this worked.
# Need Help?
2022-11-21 06:43:06 +00:00
If the above instructions don't work, please contact @Rin here, or @tammy@social .treehouse.systems.