Update macOS local dev setup instructions (#30641)

This commit is contained in:
Matt Jankowski 2024-06-10 11:22:26 -04:00 committed by GitHub
parent 3e3f3d7580
commit 28921a12fe
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -86,18 +86,18 @@ A **Vagrant** configuration is included for development purposes. To use it, com
- Run `vagrant ssh -c "cd /vagrant && bin/dev"` - Run `vagrant ssh -c "cd /vagrant && bin/dev"`
- Open `http://mastodon.local` in your browser - Open `http://mastodon.local` in your browser
### MacOS ### macOS
To set up **MacOS** for native development, complete the following steps: To set up **macOS** for native development, complete the following steps:
- Use a Ruby version manager to install the specified version from `.ruby-version` - Install [Homebrew] and run `brew install postgresql@14 redis imagemagick
- Run `bundle` to install required gems libidn nvm` to install the required project dependencies
- Run `brew install postgresql@14 redis imagemagick libidn` to install required dependencies - Use a Ruby version manager to activate the ruby in `.ruby-version` and run
- Navigate to Mastodon's root directory and run `brew install nvm` then `nvm use` to use the version from `.nvmrc` `nvm use` to activate the node version from `.nvmrc`
- Run `yarn` to install required packages - Run the `bin/setup` script, which will install the required ruby gems and node
- Run `corepack enable && corepack prepare` packages and prepare the database for local development
- Run `RAILS_ENV=development bundle exec rails db:setup` - Finally, run the `bin/dev` script which will launch services via `overmind`
- Finally, run `bin/dev` which will launch the local services via `overmind` (if installed) or `foreman` (if installed) or `foreman`
### Docker ### Docker
@ -155,3 +155,4 @@ You should have received a copy of the GNU Affero General Public License along w
[Development Containers]: https://containers.dev/supporting [Development Containers]: https://containers.dev/supporting
[Docker]: https://docs.docker.com [Docker]: https://docs.docker.com
[GitHub Codespaces]: https://docs.github.com/en/codespaces [GitHub Codespaces]: https://docs.github.com/en/codespaces
[Homebrew]: https://brew.sh