A platform for community discussion. Free, open, simple.
Go to file
Martin Brennan aef3f17b56
DEV: A different approach to breadcrumbs (#27365)
Really fully authored by Jarek, I only made the PR :)

The `DBreadcrumbItem` and `DBreadcrumbContainer` components
introduced in 1239178f49 have
some limitations, mainly that the container has no awareness of
its items, so nothing that requires positional knowledge can
be used. This is needed to use `aria-current` on the last breadcrumb
item, see https://www.w3.org/WAI/ARIA/apg/patterns/breadcrumb/examples/breadcrumb/.

We change `DBreadcrumbItem` to always be a link, removing
the need for `LinkTo`. Then, we introduce a service to keep
track of containers and items (since all items are rendered into
all containers) and make the item itself responsible for registering
to the service, and introduce the needed `aria-current` behaviour.

---------

Co-authored-by: Jarek Radosz <jradosz@gmail.com>
2024-06-07 11:31:46 +10:00
.devcontainer DEV: Replace postCreateCommand with postStartCommand (#16665) 2022-05-05 23:52:35 +02:00
.github DEV: Run flake check only on discourse/discourse (#27350) 2024-06-05 18:30:37 +02:00
.vscode-sample DEV: introduce Ember `<template>` tag support (.gjs) (#22719) 2023-07-20 21:01:12 +01:00
app DEV: A different approach to breadcrumbs (#27365) 2024-06-07 11:31:46 +10:00
bin DEV: Drop Ember 3 feature flag 2024-02-26 12:22:05 +00:00
config DEV: Initial UI for admin config area for /about (#27340) 2024-06-06 16:07:08 +03:00
db FIX: move something else flag to the bottom (#27366) 2024-06-06 15:45:30 +10:00
docs DEV: Add a callback to the validation of user custom fields in the signup form (#27369) 2024-06-06 11:17:06 -06:00
images Replace README logo with PNG (#14044) 2021-08-13 14:23:49 -04:00
lib DEV: Search for `-gnu` gem variants (#27347) 2024-06-05 14:58:02 +02:00
log
migrations DEV: Update to lastest rubocop-discourse 2024-05-27 18:06:14 +02:00
patches Revert "DEV: `@babel/plugin-proposal-decorators` -> `decorator-transforms` (#25290)" (#26971) 2024-05-10 12:48:16 +01:00
plugins FEATURE: load chat channel settings within drawer (#27346) 2024-06-06 14:01:09 +04:00
public FEATURE: Add Uyghur language (#27183) 2024-05-27 09:58:18 +02:00
script DEV: Improve user generic bulk importer anonymization (#27307) 2024-06-05 11:25:17 +00:00
spec FEATURE: Use new topic bulk actions dropdown on search page (#27303) 2024-06-07 10:41:42 +10:00
test DEV: Update chrome-launcher from 0.15.2 to 1.1.0 (#25909) 2024-02-27 11:25:11 +01:00
vendor UX: Add chevron icons for expanding and collapsing all toggles in the admin sidebar (#26246) 2024-03-21 10:25:14 +11:00
.editorconfig DEV: Update .editorconfig to match new hbs rules (#19816) 2023-01-10 16:21:16 +01:00
.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 DEV: Add recent formatting commits to `.git-blame-ignore-revs` (#19799) 2023-01-09 14:51:48 +00:00
.gitattributes DEV: Remove GitHub gjs highlighting workaround (#24791) 2023-12-08 11:55:20 +00:00
.gitignore DEV: git ignored directories should not have trailing slashes (#27130) 2024-05-22 12:33:01 +02:00
.jsdoc DEV: Remove unmaintained tidy-jsdoc dependency (#25110) 2024-01-03 10:30:54 +00:00
.licensed.yml DEV: Add mutex_m to reviewed gems (#27080) 2024-05-20 15:03:33 +08:00
.licensee.json DEV: Allow @glimmer/* packages' MIT style licenses (#27210) 2024-05-28 14:00:52 -03:00
.npmrc DEV: Prevent npm usage (#13945) 2021-08-04 22:04:58 +02:00
.prettierignore DEV: Patch `deprecated-run-loop-and-computed-dot-access` in production (#25074) 2024-01-02 10:44:26 +00:00
.prettierrc.cjs DEV: Use `@discourse/lint-configs` (#24038) 2023-10-23 12:08:35 +02:00
.rspec Add RSpec 4 compatibility (#17652) 2022-07-28 10:27:38 +08:00
.rspec_parallel DEV: Introduce parallel rspec testing 2019-04-01 11:06:47 -04:00
.rubocop.yml DEV: Update rubocop-discourse to latest version 2024-03-04 15:08:35 +01:00
.ruby-gemset.sample
.ruby-version.sample DEV: Update recommended Ruby to 3.2.1 (#20444) 2023-02-24 12:51:34 -03:00
.streerc DEV: Apply syntax_tree formatting to `app/*` 2023-01-09 14:14:59 +00:00
.template-lintrc.cjs DEV: Update js linting setup (#25365) 2024-01-24 15:30:03 +01:00
Brewfile DEV: enable frozen string literal on all files 2019-05-13 09:31:32 +08:00
CODEOWNERS DEV: Add "migrations-tooling" label to PRs for import scripts (#25062) 2023-12-28 21:26:05 +01:00
CONTRIBUTING.md Proper long form for CLA 2015-09-10 20:49:03 +02:00
COPYRIGHT.md DEV: Absorb onebox gem into core (#12979) 2021-05-26 15:11:35 +05:30
Gemfile DEV: Add `mutex_m` and `drb` to Gemfile to remove deprecation warning (#27012) 2024-05-15 05:44:50 +08:00
Gemfile.lock Build(deps): Bump faraday from 2.9.0 to 2.9.1 (#27356) 2024-06-06 00:48:50 +02:00
LICENSE.txt DEV: Absorb onebox gem into core (#12979) 2021-05-26 15:11:35 +05:30
README.md Replace Twitter screenshot with X screenshot (#25506) 2024-02-01 09:11:54 -07:00
Rakefile FIX: Do not dump schema during production database migrations (#12785) 2021-04-21 16:26:20 +01:00
config.ru DEV: enable frozen string literal on all files 2019-05-13 09:31:32 +08:00
d add wrappers for mailcatcher and sidekiq 2016-12-13 09:05:45 +11:00
discourse.sublime-project DEV: Exclude i18n .yml files from Sublime Text project. (#6473) 2018-10-10 20:21:24 +08:00
jsconfig.json Enable Embroider/Webpack code spliting for Wizard (#24919) 2023-12-20 13:15:06 +00:00
lefthook.yml DEV: Add syntax_tree check to lefthook (#19877) 2023-01-17 10:16:07 +10:00
package.json Build(deps-dev): Bump lefthook from 1.6.14 to 1.6.15 (#27309) 2024-06-04 06:47:40 +08:00
translator.yml DEV: Add "automation" plugin to Crowdin (#26497) 2024-04-03 20:00:42 +02:00
yarn.lock Build(deps): Bump the babel group with 2 updates (#27361) 2024-06-06 01:46:03 +02: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

X Community

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.