105 lines
5.7 KiB
Markdown
105 lines
5.7 KiB
Markdown
<a href="http://www.discourse.org/"></a>
|
|
|
|
Discourse is the 100% open source discussion platform built for the next decade of the Internet. It works as:
|
|
|
|
- a mailing list
|
|
- a discussion forum
|
|
- a long-form chat room
|
|
|
|
To learn more about the philosophy and goals of the project, [visit **discourse.org**](http://www.discourse.org).
|
|
|
|
## Screenshots
|
|
|
|
[](http://bbs.boingboing.net)
|
|
[](http://discuss.howtogeek.com)
|
|
[](http://discuss.newrelic.com)
|
|
[](https://talk.turtlerockstudios.com/)
|
|
[](http://discuss.atom.io)
|
|
[](http://discourse.soylent.me)
|
|
|
|
Browse [lots more notable Discourse instances](http://www.discourse.org/faq/customers/).
|
|
|
|
## Development
|
|
|
|
1. If you're **brand new to Ruby and Rails**, please see [**Discourse as Your First Rails App**](http://blog.discourse.org/2013/04/discourse-as-your-first-rails-app/) or our [**Discourse Vagrant Developer Guide**](docs/VAGRANT.md), 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**](docs/DEVELOPER-ADVANCED.md).
|
|
|
|
Before you get started, ensure you have the following minimum versions: [Ruby 2.0.0+](http://www.ruby-lang.org/en/downloads/), [PostgreSQL 9.1+](http://www.postgresql.org/download/), [Redis 2.6+](http://redis.io/download). If you're having trouble, please see our [**TROUBLESHOOTING GUIDE**](docs/TROUBLESHOOTING.md) first!
|
|
|
|
## Setting up a Discourse Forum
|
|
|
|
If you want to set up a Discourse forum for production use, see our [**Discourse Install Guide**](docs/INSTALL.md).
|
|
|
|
If you're looking for business class hosting, see [discourse.org/buy](http://www.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](https://github.com/rails/rails) — Our back end API is a Rails app. It responds to requests RESTfully in JSON.
|
|
- [Ember.js](https://github.com/emberjs/ember.js) — Our front end is an Ember.js app that communicates with the Rails API.
|
|
- [PostgreSQL](http://www.postgresql.org/) — Our main data store is in Postgres.
|
|
- [Redis](http://redis.io/) — We use Redis as a cache and for transient data.
|
|
|
|
Plus *lots* of Ruby Gems, a complete list of which is at [/master/Gemfile](https://github.com/discourse/discourse/blob/master/Gemfile).
|
|
|
|
## Contributing
|
|
|
|
[](https://travis-ci.org/discourse/discourse)
|
|
[](https://codeclimate.com/github/discourse/discourse)
|
|
|
|
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**](http://www.discourse.org). Yes we actually believe this stuff; you should too.
|
|
2. Read and sign the [**Electronic Discourse Forums Contribution License Agreement**](http://discourse.org/cla).
|
|
3. Dig into [**CONTRIBUTING.MD**](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.**](http://meta.discourse.org/t/so-you-want-to-help-out-with-discourse/3823)
|
|
|
|
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](https://github.com/discourse/discourse/blob/master/docs/SECURITY.md) for an overview of security measures in Discourse.
|
|
|
|
## The Discourse Team
|
|
|
|
The original Discourse code contributors can be found in [**AUTHORS.MD**](docs/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](http://blog.discourse.org/2013/02/the-discourse-team/) and [GitHub's list of contributors](https://github.com/discourse/discourse/contributors).
|
|
|
|
|
|
## Copyright / License
|
|
|
|
Copyright 2014 - 2015 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.](http://www.youtube.com/watch?v=Xe1TZaElTAs)
|