A platform for community discussion. Free, open, simple.
Go to file
Jeff Atwood 0405324596 Update INSTALL.md 2014-04-18 16:55:00 -07:00
.tx Add public/*.html integration with Transifex 2014-04-11 16:56:22 -04:00
app FEATURE: new title_sanitize site setting 2014-04-18 21:01:21 +02:00
bin Include binstubs generated by Rails 4 2014-02-06 11:15:00 -08:00
chef A failed attempt to upgrade ruby in the vagrant image using chef. Everything works except setting the default ruby. The command is successful, but doesn't change the default ruby. Stumped. 2014-01-08 14:46:15 -05:00
config FEATURE: new title_sanitize site setting 2014-04-18 21:01:21 +02:00
db Merge pull request #2271 from vikhyat/badge-system 2014-04-17 16:22:41 +10:00
docs Update INSTALL.md 2014-04-18 16:55:00 -07:00
images Saved ~46KB through image optimization. 2013-02-28 10:58:12 -05:00
lib FEATURE: handle 2 levels of categories in vanilla import 2014-04-19 00:59:20 +02:00
log Initial release of Discourse 2013-02-05 14:16:51 -05:00
packaging/debian Fix .pkgr.yml so that discourse can be packaged with https://pkgr.io. 2014-03-26 15:08:53 +00:00
plugins Get rid of unnecessary controller reference in poll template. 2014-04-16 12:11:41 +05:30
public Update translations from Transifex 2014-04-14 11:53:25 -04:00
script Merge pull request #2267 from Supermathie/emailtest 2014-04-17 16:16:04 +10:00
spec FEATURE: new title_sanitize site setting 2014-04-18 21:01:21 +02:00
test Use query params for sortable table headings 2014-04-17 10:52:57 -04:00
vendor Update Ember.js, Handlebars and jQuery to latest 2014-04-17 10:45:06 -04:00
.editorconfig Add EditorConfig to enforce spacing 2014-03-11 03:59:30 -04:00
.env.sample Basic Heroku integration 2013-03-13 19:07:49 +00:00
.gitattributes prevent crlf on yml files 2013-04-05 11:20:57 +02:00
.gitignore add /public/backups directory to .gitignore 2014-02-13 13:31:13 -08:00
.jshintignore Only use `.jshintignore` for the ignore rules. 2014-04-01 12:28:17 -04:00
.jshintrc Adds JS integration tests for search 2014-01-31 01:53:08 -05:00
.pkgr.yml Fix .pkgr.yml so that discourse can be packaged with https://pkgr.io. 2014-03-26 15:08:53 +00:00
.rspec Initial release of Discourse 2013-02-05 14:16:51 -05:00
.ruby-gemset.sample rvm has offically depreicated .rvmrc and recommends using .ruby-version and .ruby-gemset instead. 2013-05-23 09:16:11 -07:00
.ruby-version.sample rvm has offically depreicated .rvmrc and recommends using .ruby-version and .ruby-gemset instead. 2013-05-23 09:16:11 -07:00
.travis.yml Add JSHint to Travis validation 2014-03-08 01:19:16 -05:00
Brewfile Update the OS X development documentation 2014-01-23 22:34:29 -05:00
CONTRIBUTING.md Dropping squashing commits from contribution process 2014-02-28 18:08:06 +01:00
COPYRIGHT.txt fix trademark 2013-06-27 09:38:15 +10:00
Gemfile Update Ember.js, Handlebars and jQuery to latest 2014-04-17 10:45:06 -04:00
Gemfile.lock Update Ember.js, Handlebars and jQuery to latest 2014-04-17 10:45:06 -04:00
LICENSE.txt Initial release of Discourse 2013-02-05 14:16:51 -05:00
Procfile Standardize on 'worker' for sidekiq Procfile entry (expected by buildpack). 2013-10-08 14:45:32 +01:00
README.md Update README.md 2014-04-16 03:00:29 -07:00
Rakefile Prevent crashes during migration in certain PostgreSQL configurations 2013-04-10 13:26:55 +02:00
Vagrantfile Update Vagrantfile and docs/VAGRANT.md for new box 2013-10-16 13:55:26 -04:00
adminjs Initial release of Discourse 2013-02-05 14:16:51 -05:00
config.ru Allow running discourse with prefix with passenger without requiring a symlink 2013-04-10 14:23:49 +02:00
discourse.sublime-project Renamed `sublime-project` to `discourse.sublime-project` as sublime expects a `.sublime-project` 2013-12-23 14:46:35 -05:00
jsapp Initial release of Discourse 2013-02-05 14:16:51 -05:00

README.md

Logo

Discourse is the 100% open source, next-generation discussion platform built for the next decade of the Internet. It works as:

  • a mailing list
  • a discussion forum
  • a longer form chat room

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

Screenshots

Getting Started

  1. If you're brand new to Ruby and Rails, please see Discourse as Your First Rails App or our Discourse Vagrant Developer Guide, which includes a development environment in a virtual machine.

  2. If you're familiar with how Rails works and are comfortable setting up your own environment, use our Discourse Advanced Developer Guide.

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

Setting up a Discourse Forum

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:

Browsers Tablets Smartphones
Safari 5.1+ iPad 2+ iOS 6+
Google Chrome 23+ Android 4.1+ Android 4.1+
Internet Explorer 10+ Windows 8 Windows Phone 8
Firefox 16+

Internet Explorer 9.0 is technically supported, but it is our absolute minimum spec browser and may not be fully functional.

Built With

  • Ruby on Rails — Our back end API is a Rails app. It responds to requests RESTfully and responds 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 for our job queue, rate limiting, as a cache and for transient data.

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

Contributing

Build Status Code Climate

Discourse is 100% free and open-source. We encourage and support an active, healthy community that accepts contributions from the public. We'd like you to be a part of that community.

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. Not sure what to work on? We've got some ideas.

We look forward to seeing your pull requests!

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 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:

http://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.

Dedication

Discourse is built with love, Internet style.