A platform for community discussion. Free, open, simple.
Go to file
Alan Guo Xiang Tan e0ef88abca
DEV: Run QUnit tests for official Discourse themes (#24405)
Why this change?

As the number of themes which the Discourse team supports officially
grows, we want to ensure that changes made to Discourse core do not
break the plugins. As such, we are adding a step to our Github actions
test job to run the QUnit tests for all official themes.

What does this change do?

This change adds a new job to our tests Github actions workflow to run the QUnit
tests for all official plugins. This is achieved with the following
changes:

1. Update `testem.js` to rely on the `THEME_TEST_PAGES` env variable to set the
   `test_page` option when running theme QUnit tests with testem. The
   `test_page` option [allows an array to be specified](https://github.com/testem/testem#multiple-test-pages) such that tests for
   multiple pages can be run at the same time. We are relying on a ENV variable
   because  the `testem` CLI does not support passing a list of pages
   to the `--test_page` option.

2. Support a `/testem-theme-qunit/:testem_id/theme-qunit` Rails route in the development environment. This
   is done because testem prefixes the path with a unique ID to the configured `test_page` URL.
   This is problematic for us because we proxy all testem requests to the
   Rails server and testem's proxy configuration option does not allow us
   to easily rewrite the URL to remove the prefix. Therefore, we configure a proxy in testem to prefix `theme-qunit` requests with
  `/testem-theme-qunit` which can then be easily identified by the Rails server and routed accordingly. 

3. Update `qunit:test` to support a `THEME_IDS` environment variable
   which will allow it to run QUnit tests for multiple themes at the
   same time.

4. Support `bin/rake themes:qunit[ids,"<theme_id>|<theme_id>"]` to run
   the QUnit tests for multiple themes at the same time.

5. Adds a `themes:qunit_all_official` Rake task which runs the QUnit
   tests for all the official themes.
2023-11-17 07:17:32 +08:00
.devcontainer
.github DEV: Run QUnit tests for official Discourse themes (#24405) 2023-11-17 07:17:32 +08:00
.vscode-sample DEV: introduce Ember `<template>` tag support (.gjs) (#22719) 2023-07-20 21:01:12 +01:00
app DEV: Run QUnit tests for official Discourse themes (#24405) 2023-11-17 07:17:32 +08:00
bin DEV: Allow explicitly enabling/disabling system tests in bin/turbo_rspec (#23515) 2023-09-11 13:11:06 -05:00
config DEV: Run QUnit tests for official Discourse themes (#24405) 2023-11-17 07:17:32 +08:00
db DEV: Rename `experimental_passkeys` to `enable_passkeys` (#24349) 2023-11-13 15:04:15 -05:00
docs DEV: Add new experimental admin UI route and sidebar (#23952) 2023-10-19 14:23:41 +10:00
documentation
images
lib DEV: Run QUnit tests for official Discourse themes (#24405) 2023-11-17 07:17:32 +08:00
log
migrations DEV: Add initial structure for migrations-tooling 2023-10-13 16:03:55 +02:00
plugins DEV: Remove unnecessary fab! blocks (#24419) 2023-11-16 13:22:08 -05:00
public FIX: Use correct location for wizard background image (#24183) 2023-10-31 15:57:47 +00:00
script DEV: Silence successful database migration output in github actions (#24416) 2023-11-16 15:55:41 +00:00
spec DEV: Unskip flaky editing sidebar nav menu categories on mobile test (#24412) 2023-11-17 06:37:20 +08:00
test DEV: Drop `/theme-qunit` from smoke test (#23562) 2023-09-13 16:14:27 +01:00
vendor DEV: Modernise highlightjs loading (#24197) 2023-11-10 20:39:48 +00:00
.editorconfig
.eslintignore DEV: convert I18n pseudo package into real package (discourse-i18n) (#23867) 2023-10-12 14:44:01 +01:00
.eslintrc.cjs DEV: Use `@discourse/lint-configs` (#24038) 2023-10-23 12:08:35 +02:00
.git-blame-ignore-revs
.gitattributes DEV: introduce Ember `<template>` tag support (.gjs) (#22719) 2023-07-20 21:01:12 +01:00
.gitignore FEATURE: Bundle discourse-spoiler-alert plugin into core (#24030) 2023-10-23 13:50:43 -06:00
.jsdoc
.licensed.yml Build(deps): Bump faraday from 2.7.10 to 2.7.11 (#23554) 2023-09-14 01:33:44 +02:00
.licensee.json DEV: Update eslint/prettier (#22226) 2023-06-21 20:59:03 +02:00
.npmrc
.prettierignore DEV: convert I18n pseudo package into real package (discourse-i18n) (#23867) 2023-10-12 14:44:01 +01:00
.prettierrc.cjs DEV: Use `@discourse/lint-configs` (#24038) 2023-10-23 12:08:35 +02:00
.rspec
.rspec_parallel
.rubocop.yml Build(deps-dev): Bump rubocop-discourse from 3.4.0 to 3.4.1 (#24375) 2023-11-14 22:56:30 +01:00
.ruby-gemset.sample
.ruby-version.sample
.streerc
.template-lintrc.js DEV: Use `@discourse/lint-configs` (#24038) 2023-10-23 12:08:35 +02:00
Brewfile
CODEOWNERS DEV: Add codeowner for migrations related code 2023-10-13 16:03:55 +02:00
CONTRIBUTING.md
COPYRIGHT.md
Gemfile DEV: Set selenium-webdriver version to 4.14 (#24161) 2023-10-30 15:52:08 -04:00
Gemfile.lock Build(deps): Bump unf_ext from 0.0.9 to 0.0.9.1 (#24422) 2023-11-16 23:57:59 +01:00
LICENSE.txt
README.md FIX: correct link to meta.discourse.org 2023-08-29 13:17:05 +02:00
Rakefile
config.ru
d
discourse.sublime-project
jsconfig.json DEV: Consolidate and update jsconfig, and add types packages (#23824) 2023-10-18 12:13:20 +01:00
lefthook.yml
package.json DEV: Modernise highlightjs loading (#24197) 2023-11-10 20:39:48 +00:00
translator.yml DEV: Fix translator-bot configuration for footnote plugin (#24065) 2023-10-23 23:10:17 +02:00
yarn.lock DEV: Modernise highlightjs loading (#24197) 2023-11-10 20:39:48 +00:00

README.md

Discourse is the online home for your community. We offer a 100% open source community platform to those who want complete control over how and where their site is run.

Our platform has been battle-tested for over a decade and continues to evolve to meet users needs for a powerful community platform. Discourse allows you to create discussion topics and connect using real-time chat, as well as access an ever-growing number of official and community themes. In addition, we offer a wide variety of plugins for features ranging from chatbots powered by Discourse AI to functionalities like SQL analysis using the Data Explorer plugin.

To learn more, visit discourse.org and join our support community at meta.discourse.org.

Screenshots

Discourse 3.1

Boing Boing

Mobile

Browse lots more notable Discourse instances.

Development

To get your environment set up, follow the community setup guide for your operating system.

  1. If you're on macOS, try the macOS development guide.
  2. If you're on Ubuntu, try the Ubuntu development guide.
  3. If you're on Windows, try the Windows 10 development guide.
  4. If you're looking to use a simpler Docker-based install, try the Docker development guide.

If you're familiar with how Rails works and are comfortable setting up your own environment, you can also try out the Discourse Advanced Developer Guide, which is aimed primarily at Ubuntu and macOS environments.

Before you get started, ensure you have the following minimum versions: Ruby 3.2+, PostgreSQL 13, Redis 7. If you're having trouble, please see our TROUBLESHOOTING GUIDE first!

Setting up Discourse

If you want to set up a Discourse forum for production use, see our Discourse Install Guide.

If you're looking for official hosting, see discourse.org/pricing.

Requirements

Discourse is built for the next 10 years of the Internet, so our requirements are high.

Discourse supports the latest, stable releases of all major browsers and platforms:

Browsers Tablets Phones
Apple Safari iPadOS iOS
Google Chrome Android Android
Microsoft Edge
Mozilla Firefox

Additionally, we aim to support Safari on iOS 15.7+.

Built With

  • Ruby on Rails — Our back end API is a Rails app. It responds to requests RESTfully in JSON.
  • Ember.js — Our front end is an Ember.js app that communicates with the Rails API.
  • PostgreSQL — Our main data store is in Postgres.
  • Redis — We use Redis as a cache and for transient data.
  • BrowserStack — We use BrowserStack to test on real devices and browsers.

Plus lots of Ruby Gems, a complete list of which is at /main/Gemfile.

Contributing

Build Status

Discourse is 100% free and open source. We encourage and support an active, healthy community that accepts contributions from the public including you!

Before contributing to Discourse:

  1. Please read the complete mission statements on discourse.org. Yes we actually believe this stuff; you should too.
  2. Read and sign the Electronic Discourse Forums Contribution License Agreement.
  3. Dig into CONTRIBUTING.MD, which covers submitting bugs, requesting new features, preparing your code for a pull request, etc.
  4. Always strive to collaborate with mutual respect.
  5. Not sure what to work on? We've got some ideas.

We look forward to seeing your pull requests!

Security

We take security very seriously at Discourse; all our code is 100% open source and peer reviewed. Please read our security guide for an overview of security measures in Discourse, or if you wish to report a security issue.

The Discourse Team

The original Discourse code contributors can be found in AUTHORS.MD. For a complete list of the many individuals that contributed to the design and implementation of Discourse, please refer to the official Discourse blog and GitHub's list of contributors.

Copyright 2014 - 2023 Civilized Discourse Construction Kit, Inc.

Licensed under the GNU General Public License Version 2.0 (or later); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:

https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Discourse logo and “Discourse Forum” ®, Civilized Discourse Construction Kit, Inc.

Accessibility

To guide our ongoing effort to build accessible software we follow the W3Cs Web Content Accessibility Guidelines (WCAG). If you'd like to report an accessibility issue that makes it difficult for you to use Discourse, email accessibility@discourse.org. For more information visit discourse.org/accessibility.

Dedication

Discourse is built with love, Internet style.