macOSにDiscourseをインストールして開発する

[Discourse]

このガイドはmacOS開発環境のインストール手順を扱っています。本番環境向けの手順については、こちらを参照してください: Install Discourse in production with the official supported instructions

DiscourseをmacOSにセットアップしてハックしたり開発したりしたいのですね？

ここでは、お使いのMacにRuby/Rails/Postgres/Redisがインストールされていないことを前提とします。始めましょう ！

Discourseの依存関係をインストールする

システムに次のパッケージが必要です:

• Git
• rbenv または asdf
• ruby-build
• Ruby (最新の安定版)
• Rails
• PostgreSQL
• SQLite
• Redis
• Node.js
• pnpm
• MailHog**
• ImageMagick**

** オプション

ターミナルを再起動してください

Discourseの依存関係をインストールしたので、Discourse自体のインストールに進みましょう。

ターミナルを再起動する

シェルを終了して再起動することで、インストールされたパッケージへのパスがターミナルによって正しく認識されるようになります。

Discourseをクローンする

~/discourse フォルダにDiscourseリポジトリをクローンします:

git clone https://github.com/discourse/discourse.git ~/discourse

~ はホームフォルダを意味し、Discourseのソースコードはホームフォルダで利用可能になります。

Discourseのブートストラップ

Discourseフォルダに移動します:

cd ~/discourse

必要なgemをインストールします

bundle install

JSの依存関係をインストールします

pnpm install

次に、ローカルのDiscourseインスタンスを設定するために、次のコマンドを実行します:

bundle exec rake db:create
bundle exec rake db:migrate
RAILS_ENV=test bundle exec rake db:create db:migrate

RailsサーバーとEmberサーバーを起動します。ここには2つのオプションがあります。

オプション 1: 2つの別々のターミナルタブ/ウィンドウを使用して、RailsとEmber CLIを個別に実行します。

bundle exec rails server

と

bin/ember-cli

オプション 2: 1つのターミナルタブ/ウィンドウのみを使用します:

bin/ember-cli -u # バックグラウンドでUnicornサーバーを実行します

これで、http://localhost:4200 にアクセスして、ローカルのDiscourseインストールを確認できるはずです。（初回ロードはサーバーのウォームアップのため最大1分かかる場合があることに注意してください。）

また、スペックを実行することも試せます:

bundle exec rake autospec

すべての（またはほとんどすべての）テストがパスするはずです。

新しい管理者の作成

新しい管理者を作成するには、次のコマンドを実行します:

RAILS_ENV=development bundle exec rake admin:create

プロンプトに従って管理者アカウントを作成します。

メールの設定

MailHogを実行します:

mailhog

---

おめでとうございます！これであなた自身のDiscourseインストールの管理者になりました！

ハッピーハッキング！そして始めるために、初心者向けDiscourseプラグイン作成ガイドを参照してください。

---

このドキュメントはバージョン管理されています - 変更の提案はgithubで行ってください。

[jamesmarkcook (James Cook)]

If anyone is getting failing specs with most of them being .count errors, then try the following:

RAILS_ENV=test bundle exec rake db:reset

I had a problem where development data somehow got into my test database and was causing lots of failures.

[henrikbg (Henrik Berg)]

Is it possible to reset a discourse completely?

[techAPJ (Arpit Jalan)]

@Henrik_B

Is it possible to reset a discourse completely?

Yes, do:

rake db:drop db:create db:migrate

Note that this will wipe everything and you will have to create your Admin user account again.

[Chaboi_3000]

Can someone assist me in how I can update my discourse?

/launcher rebuild app

returns an error.

[techAPJ (Arpit Jalan)]

./launcher rebuild app is for discourse_docker based production setup. To update local/development Discourse instance you need:

cd ~/discourse
git pull origin master

[Chaboi_3000]

@techAPJ

git pull origin master

I get this error @techAPJ,

error: Your local changes to the following files would be overwritten by merge:
	.gitignore
Please commit your changes or stash them before you merge.
Aborting

[techAPJ (Arpit Jalan)]

The error message is pretty clear:

Please commit your changes or stash them before you merge.

If you want to ignore your local changes, do:

git fetch origin
git reset --hard origin/master

[Decorbuz]

Using the guide from the Ruby on Rails forum, I’m currently stuck on step 7.

This is probably a very “newbie” question, but how do I “point” to the experimental branch that was linked in that topic? I tried a few things and was ultimately giving the Unknown command mini_racer, message every single time.

[blake (Blake Erickson)]

They’re fine asking here.

There are some specific m1 instructions we wrote that we reference on the rails forum in this guide.

@Decorbuz

This is probably a very “newbie” question, but how do I “point” to the experimental branch that was linked in that topic?

I’d have to look on my m1 air later, and maybe my fellow coworks who recently setup new macs might know better if this is even still needed, but there is an example of how to point to a branch in step 7:

gem 'mini_racer', github: 'rubyjs/mini_racer', branch: 'refs/pull/186/head'

So you would edit this line in your local version of discourse/Gemfile:

Gemfile

and then run bundle install.

[Decorbuz]

@pfaffman

If you didn’t follow these instructions (I don’t see a step 7) then this isn’t a very good place to ask your question.

It’s linked right at the top of the original post.

The topic from the Ruby on Rails forum has been dead for many months now. The OP hasn’t been active since Feburary and hasn’t replied to any comments there asking for help.

There are more people to help me here. Just saying.

@blake

there is an example of how to point to a branch in step 7:

gem 'mini_racer', github: 'rubyjs/mini_racer', branch: 'refs/pull/186/head'

I tried copying that into Terminal and received the same Unknown command mini_racer, error from before.

Admittedly, the guide from the Ruby on Rails forum isn’t as clear as I’d hope in that regard.

Apologies in advance…

[blake (Blake Erickson)]

@Decorbuz

I tried copying that into Terminal and received the same Unknown command mini_racer, error from before.

It’s not a command to run. You will need to EDIT the actual text file called “Gemfile” located inside the discourse directory.

[Decorbuz]

@blake

You will need to EDIT the actual text file called “Gemfile” located inside the discourse directory.

Doh!

Thanks! Let me try that right now.

In my opinion, somebody should edit the guide from the Ruby on Rails forum and provide further clarification regarding step 7. Just my two cents though.

I will be right back. Hold on a second…

[blake (Blake Erickson)]

Sorry I have to run, but I think that mini_racer fix for m1 macs has been merged in. I just checked my Gemfile on my m1 mac and mine isn’t edited. So I think you can skip step 7.

[Decorbuz]

I ran step 8 and received the Could not locate Gemfile error.

I (think) I was able to figure out step 7, but step 8 is still giving me trouble and is spitting out the error mentioned above.

[blake (Blake Erickson)]

@Decorbuz

I ran step 8 and received the Could not locate Gemfile error.

You need to be inside of the discourse directory when you run bundle install.

@techAPJ

Clone Discourse

Clone the Discourse repository in ~/discourse folder:

git clone https://github.com/discourse/discourse.git ~/discourse

~ indicates home folder, so Discourse source code will be available in your home folder.

Bootstrap Discourse

Switch to your Discourse folder:

cd ~/discourse

Install the needed gems

bundle install

[JQ331]

@merefield

Actually it’s a bit more than a couple of bucks (it’s a 4GB 8 core VPS - probably overkill) but allows me to develop from anywhere on any platform. Pretty performant but there will always be a few seconds delay if you restart the web server.

Hi @merefield: Can you describe your remote setup a little more?

While developing a theme allows me to add changes on a live site, for developing a plugin I don’t see any way around doing it on my local machine, having the whole discourse codebase there (with my plugin on top of it).

The result is that for any (non-css) change when coding a plugin, when I reload it 1) kicks off my computer’s fan and 2) takes a solid 30 seconds to reload. And if I need to restart the server, it takes several minutes.

Those delays really add up–with the result that it might take me an hour to code something up that with my normal coding flow (where there’s hot reload or at most 2-3 seconds per change) would take 15 minutes.

So, I’d appreciate any suggestions for speeding things up.

[merefield (Robert)]

This arguably would be better on the Ubuntu topic, as I’m just running that install on a cloud server, fronted by nginx and a full DNS (no docker), so I’m actually addressing the domain. Running everything from the terminal. I’ve even got Ember CLI working well in that set up now.

It’s not that quick either, but fast enough. It has the benefit of being able to run and test full https callback services.

The fastest plugin development environment by far that I’m aware of is local Docker Dev on WSL2 which screams. It’s also extremely simple to maintain. Unfortunately discourse_theme doesn’t work in that environment yet afaik so I’m back to my cloud server for that work.

It’s a little odd why Apple is lagging behind here? The Microsoft engineers have shown themselves to be very canny.

[Nacho_Caballero]

Ruby 2.7.3 のインストールでエラーが発生した場合に備えて、Xcode 12 以降で何かが変更され、rbenv でのインストールプロセスが壊れるようです。

installing older Ruby versions on OSX after XCode 12

最新バージョンの psych と libyaml がインストールされているにもかかわらず、次のようなエラーが 계속 발생しました。

It seems your ruby installation is missing psych (for YAML output).
To eliminate this warning, please install libyaml and reinstall your ruby.

ガイドで提案されている回避策を試しましたが、同じエラーが 계속発生し、最終的には rvm を使用する必要がありました。

rvm install 2.7.3

[JQ331]

プラグイン開発をより速く行う方法について、最近アプローチを変更しました。そして、それは素晴らしい結果をもたらしています。基本的に、フロントエンドの作業はすべてテーマコンポーネントに移動し、プラグイン自体ではバックエンドの作業のみをコーディングします。他の人も以前にそれに気づいていたことは知っています。しかし、今私がそれをやっていると、プログラミングははるかに速く、より快適になりました。詳細はこちらをご覧ください。