Installer Discourse sur macOS pour le développement

[Discourse]

Ce guide couvre les instructions d’installation pour un environnement de développement macOS. Pour les guides de production, consultez : Install Discourse in production with the official supported instructions

Vous souhaitez donc configurer Discourse sur macOS pour le modifier et développer avec ?

Nous supposerons que vous n’avez pas Ruby/Rails/Postgres/Redis installé sur votre Mac. Commençons !

Installer les dépendances de Discourse

Vous aurez besoin des paquets suivants sur votre système :

• Git
• rbenv ou asdf
• ruby-build
• Ruby (dernière version stable)
• Rails
• PostgreSQL
• SQLite
• Redis
• Node.js
• pnpm
• MailHog**
• ImageMagick**

** optionnel

redémarrez votre terminal

Maintenant que nous avons installé les dépendances de Discourse, passons à l’installation de Discourse lui-même.

Redémarrer votre Terminal

Quittez votre shell et redémarrez-le pour vous assurer que les chemins d’accès aux paquets installés sont correctement pris en compte par le Terminal.

Cloner Discourse

Clonez le dépôt Discourse dans le dossier ~/discourse :

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

~ indique le dossier personnel, donc le code source de Discourse sera disponible dans votre dossier personnel.

Initialiser Discourse

Passez à votre dossier Discourse :

cd ~/discourse

Installez les gems nécessaires

bundle install

Installez les dépendances JS

pnpm install

Ensuite, exécutez ces commandes pour configurer votre instance locale de Discourse :

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

Démarrez les serveurs rails + Ember, vous avez deux options ici.

Option 1 : en utilisant deux onglets/fenêtres de Terminal séparés, exécutez Rails et Ember CLI séparément via

bundle exec rails server

et

bin/ember-cli

Option 2 : en utilisant un seul onglet/fenêtre de Terminal :

bin/ember-cli -u # exécutera le serveur Unicorn en arrière-plan

Vous devriez maintenant pouvoir naviguer vers http://localhost:4200 pour voir votre installation locale de Discourse. (Notez que le premier chargement peut prendre jusqu’à une minute pendant que le serveur chauffe.)

Vous pouvez également essayer d’exécuter les spécifications :

bundle exec rake autospec

Tous (ou presque tous) les tests devraient passer.

Créer un nouvel administrateur

Pour créer un nouvel administrateur, exécutez la commande suivante :

RAILS_ENV=development bundle exec rake admin:create

Suivez les instructions pour créer un compte administrateur.

Configurer le courrier

Exécutez MailHog :

mailhog

---

Félicitations ! Vous êtes maintenant l’administrateur de votre propre installation Discourse !

Bon codage ! Et pour commencer, consultez Guide du débutant pour la création de plugins Discourse.

---

Ce document est contrôlé par version - suggérez des modifications sur 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]

Au cas où quelqu’un rencontrerait des erreurs en essayant d’installer ruby 2.7.3, apparemment quelque chose a changé après Xcode 12, ce qui casse le processus d’installation avec rbenv :

installing older Ruby versions on OSX after XCode 12

J’ai continué à recevoir ceci, même si j’ai les dernières versions de psych et libyaml installées :

Il semble que votre installation de ruby manque de psych (pour la sortie YAML).
Pour éliminer cet avertissement, veuillez installer libyaml et réinstaller votre ruby.

J’ai essayé la solution de contournement qu’ils suggèrent dans le guide, mais j’ai continué à recevoir la même erreur et j’ai fini par devoir utiliser rvm :

rvm install 2.7.3

[JQ331]

Concernant la manière de programmer plus rapidement lors de la création d’un plugin, j’ai récemment changé d’approche. Et cela fonctionne très bien. En gros, déplacez tout ce qui concerne le front-end vers un composant de thème, et ne codez que les éléments du back-end dans le plugin lui-même. Je sais que d’autres l’ont déjà compris. Mais maintenant que je le fais, la programmation est tellement plus rapide et agréable. Détails ici.