Reading the repo

Opening the box…

How to set up discourse (discourse/discourse) · gitmanual

Assembly instructions

discourse/discourse

A platform for community discussion. Free, open, simple.

Node.jsRubyRails#discourse#ember#forum#javascript

Difficulty: Moderate
Time: about 15 min
Stars: ★ 48,048
Activity: Updated this month
License: GPL-2.0
Open issues: 297
Got it running: Be the first
Looked up: 3 h ago

Saved setup from 3 h ago

Start here

Website ↗discourse.orgThe project's own site.In the browser ↗Open in GitHub CodespacesThe repo ships a dev container, so nothing to install.

Will it work on my device?

Yes, it runs on macOS

Apps are only published for Linux.
You'll build it yourself with Node.js, Ruby.

Checking for

No macOS app in the box

No ready-made macOS app or install command in _gh-attach-assets. There are apps for Linux.

Did you get it running?

No reports for macOS yet.

Still stuck? Get a written guide

Claude reads the 12 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.

Parts list

1×Node.js >= 20runtime
1×Ruby ~> 4.0.0runtime
1×pnpm pnpm@12.11.2package manager
1×bundler package manager

Share this manual

Good to know

Monorepo (workspaces) — install from the repo root.
Dev Container config found — you can open it in VS Code Dev Containers or GitHub Codespaces for a zero-setup environment.
Has AGENTS.md — instructions for coding agents. You can open Claude Code (or another agent) in the cloned folder and ask it to do the setup for you.
Nested projects: docs/developer-guides/Gemfile, docs/developer-guides/package.json, frontend/asset-processor/package.json, frontend/deprecation-silencer/package.json and 11 more

package.json scripts (20)

preparepnpm types:generate
devbin/dev
lintconcurrently "pnpm:lint:*(!fix)" --names "lint:"
lint:fixconcurrently "pnpm:lint:*:fix" --names "fix:"
lint:csspnpm stylelint 'app/assets/stylesheets/**/*.scss' $(script/list_bundled_plugins '/assets/stylesheets/**/*.scss') 'themes/**/*.scss'
lint:css:fixpnpm stylelint --fix 'app/assets/stylesheets/**/*.scss' $(script/list_bundled_plugins '/assets/stylesheets/**/*.scss') 'themes/**/*.scss'
lint:jseslint ./frontend $(script/list_bundled_plugins) ./themes --cache --concurrency auto --no-error-on-unmatched-pattern --max-warnings 0
lint:js:fixeslint --fix ./frontend $(script/list_bundled_plugins) ./themes --no-error-on-unmatched-pattern
lint:prettierpnpm pprettier --list-different 'app/assets/stylesheets/**/*.scss' 'frontend/**/*.{js,gjs,ts,gts,mts,cts,cjs,mjs,css}' $(script/list_bundled_plugins '/assets/stylesheets/**/*.scss') $(script/list_bundled_plugins '/{assets,admin/assets,test}/javascripts/**/*.{js,gjs,ts,gts,mts,cts,cjs,mjs}') 'themes/**/*.{js,gjs,ts,gts,cjs,mjs,scss}'
lint:prettier:fixpnpm prettier -w --no-error-on-unmatched-pattern 'app/assets/stylesheets/**/*.scss' 'frontend/**/*.{js,gjs,ts,gts,mts,cts,cjs,mjs,css}' $(script/list_bundled_plugins '/assets/stylesheets/**/*.scss') $(script/list_bundled_plugins '/{assets,admin/assets,test}/javascripts/**/*.{js,gjs,ts,gts,mts,cts,cjs,mjs}') 'themes/**/*.{js,gjs,ts,gts,cjs,mjs,scss}'
lint:typestsc -b --runExternalCode
types:generatepnpm --dir=frontend/discourse-i18n tsc && pnpm --dir=frontend/discourse-types generate-external
types:watchpnpm types:generate && tsc -b --runExternalCode --watch --preserveWatchOutput
lttf:ignorelint-to-the-future ignore
lttf:outputlint-to-the-future output -o ./lint-progress/
lint-progresspnpm lttf:output && npx html-pages ./lint-progress --no-cache
playwright-installplaywright install --no-shell chromium
postinstallnode script/copy_vendored_assets.mjs
buildpnpm --silent --dir=frontend/discourse build
startpnpm --silent --dir=frontend/discourse start

Files we read (12)

.devcontainer/devcontainer.json

.github/workflows/check-pr-body.yml

.github/workflows/dependabot-bundler-checksums.yml

.github/workflows/developer-docs-lint.yml

.github/workflows/linting.yml

.github/workflows/migration-tests.yml

.github/workflows/release-prepare-latest-bump.yml

Gemfile

README.md

docs/INSTALL.md

package.json

pnpm-workspace.yaml

Branch main · 27,753 files in the repo