A platform for community discussion. Free, open, simple.
Go to file
Alan Guo Xiang Tan fb2507c6ce
DEV: Centralise logic for updating sidebar section links (#19275)
The centralization helps in reducing code duplication in our code base
and more importantly, centralizing logic for guardian checks into a
single spot.
2022-12-01 09:32:35 +08:00
.devcontainer DEV: Replace postCreateCommand with postStartCommand (#16665) 2022-05-05 23:52:35 +02:00
.github DEV: Run system tests with documentation and profiling on actions (#19271) 2022-12-01 05:54:17 +08:00
.vscode-sample DEV: Move vscode config files to `.vscode-sample` directory (#11943) 2021-02-03 14:14:39 +00:00
app DEV: Centralise logic for updating sidebar section links (#19275) 2022-12-01 09:32:35 +08:00
bin DEV: Minimal first pass of rails system test setup (#16311) 2022-09-28 11:48:16 +10:00
config FEATURE: Separate notification indicators for new PMs and reviewables (#19201) 2022-12-01 07:05:32 +08:00
db FEATURE: Add user tips for post and topic features (#18964) 2022-11-15 17:36:08 +02:00
docs FEATURE: API to customize server side composer errors handling in the client side (#19107) 2022-11-21 13:11:29 -03:00
images Replace README logo with PNG (#14044) 2021-08-13 14:23:49 -04:00
lib FIX: Handle null svg class for excerpt parsing (#19276) 2022-12-01 10:56:16 +10:00
log
plugins DEV: Colocate all chat component templates (#19266) 2022-11-30 17:55:07 +00:00
public Update translations (#19150) 2022-11-22 15:01:19 +01:00
script PERF: Update `Group#user_count` counter cache outside DB transaction (#19256) 2022-11-30 11:52:08 -03:00
spec DEV: Centralise logic for updating sidebar section links (#19275) 2022-12-01 09:32:35 +08:00
test DEV: Extensively use `includes()` (#17541) 2022-07-17 20:48:36 +02:00
vendor DEV: Update moment-timezone (#19052) 2022-11-16 16:57:40 +01:00
.editorconfig Set trim_trailing_whitespace false for markdown 2016-06-25 22:29:01 +04:30
.eslintignore DEV: Upgrade "lefthook" and skip hooks during merge/rebase (#18910) 2022-11-07 17:13:21 +01:00
.eslintrc DEV: Await for all async MessageBus callbacks (#17966) 2022-08-17 12:44:48 +02:00
.git-blame-ignore-revs DEV: Update commit hash for .git-blame-ignore-revs 2022-08-17 16:47:16 +08:00
.gitattributes Use proper encoding for email fixtures. 2018-02-21 17:06:35 +08:00
.gitignore DEV: Move `discourse-chat` to the core repo. (#18776) 2022-11-02 10:41:30 -03:00
.licensed.yml DEV: Upgrade to Rails 7 2022-04-28 11:51:03 +02:00
.licensee.json DEV: Add CI job that audits dependency licenses (#16568) 2022-04-26 14:09:42 -04:00
.npmrc DEV: Prevent npm usage (#13945) 2021-08-04 22:04:58 +02:00
.prettierignore DEV: Skip loading plugin JS when running only core tests (#18047) 2022-08-23 10:25:07 +01:00
.prettierrc DEV: upgrades dev config (#10588) 2020-09-04 13:33:03 +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 Revert "Bump rubocop-discourse to 2.3.0." 2020-07-24 13:18:49 +08:00
.ruby-gemset.sample
.ruby-version.sample DEV: update .ruby-version.sample (#18426) 2022-09-29 13:38:44 -05:00
.streerc DEV: Add .streerc file (#18878) 2022-11-04 14:51:04 +10:00
.template-lintrc.js DEV: Enable `no-args-paths` and `no-attrs-in-components` lint rules (#18709) 2022-10-21 21:44:14 +01:00
Brewfile DEV: enable frozen string literal on all files 2019-05-13 09:31:32 +08: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 Fixes for vBulletin bulk importer (#17618) 2022-11-28 16:30:19 -03:00
Gemfile.lock Build(deps): Bump rubocop-ast from 1.23.0 to 1.24.0 (#19270) 2022-11-30 22:17:50 +01:00
LICENSE.txt DEV: Absorb onebox gem into core (#12979) 2021-05-26 15:11:35 +05:30
README.md DEV: Remove broken link from README (#18236) 2022-09-13 15:07:27 -04: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.base.json DEV: Add more excludes to jsconfig (#17975) 2022-08-17 21:51:40 +02:00
lefthook.yml DEV: Upgrade "lefthook" and skip hooks during merge/rebase (#18910) 2022-11-07 17:13:21 +01:00
package.json DEV: Bump chrome-launcher (#19082) 2022-11-18 07:03:05 +08:00
translator.yml DEV: Add chat plugin to Crowdin (#18838) 2022-11-02 15:18:02 +01:00
yarn.lock DEV: Bump chrome-launcher (#19082) 2022-11-18 07:03:05 +08:00

README.md

Discourse is the 100% open source discussion platform built for the next decade of the Internet. Use it as a:

  • mailing list
  • discussion forum
  • long-form chat room

To learn more about the philosophy and goals of the project, visit discourse.org.

Screenshots

Boing Boing

Mobile

Browse lots more notable Discourse instances.

Development

To get your environment setup, 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.

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 2.7+, PostgreSQL 13+, Redis 6.2+. 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 business class hosting, see discourse.org/buy.

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 12.5+ until January 2023 (Discourse 3.0).

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 - 2022 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.