2019-02-22 23:29:27 +08:00
< a href = "https://www.discourse.org/" > < img src =
2019-02-05 05:52:11 +08:00
"https://user-images.githubusercontent.com/1681963/52239617-e2683480-289c-11e9-922b-5da55472e5b4.png"
width="300px">< / a >
2013-02-06 03:16:51 +08:00
2017-04-12 06:11:50 +08:00
Discourse is the 100% open source discussion platform built for the next decade of the Internet. Use it as a:
2013-02-06 03:16:51 +08:00
2017-04-12 06:11:50 +08:00
- mailing list
- discussion forum
- long-form chat room
2013-02-06 03:16:51 +08:00
2019-02-22 23:29:27 +08:00
To learn more about the philosophy and goals of the project, [visit **discourse.org** ](https://www.discourse.org ).
2013-08-10 07:35:25 +08:00
2014-03-02 16:30:11 +08:00
## Screenshots
2014-02-22 16:56:30 +08:00
2015-09-24 14:20:58 +08:00
2019-02-05 05:52:11 +08:00
< a href = "https://bbs.boingboing.net" > < img alt = "Boing Boing" src = "https://user-images.githubusercontent.com/1681963/52239245-04ad8280-289c-11e9-9c88-8c173d4a0422.png" width = "720px" > < / a >
< a href = "https://twittercommunity.com/" > < img src = "https://user-images.githubusercontent.com/1681963/52239250-04ad8280-289c-11e9-9e42-574f6eaab9d7.png" width = "720px" > < / a >
2019-02-22 23:29:27 +08:00
< a href = "https://discuss.howtogeek.com" > < img src = "https://user-images.githubusercontent.com/1681963/52239247-04ad8280-289c-11e9-9706-fd66bc0749dc.png" width = "720px" > < / a >
2019-02-05 05:52:11 +08:00
< a href = "https://talk.turtlerockstudios.com/" > < img src = "https://user-images.githubusercontent.com/1681963/52239249-04ad8280-289c-11e9-9155-f0ccc5decc50.png" width = "720px" > < / a >
2014-03-01 16:40:35 +08:00
2019-02-05 05:52:11 +08:00
< img src = "https://user-images.githubusercontent.com/1681963/52239118-b304f800-289b-11e9-9904-16450680d9ec.jpg" alt = "Mobile" width = "414" >
2017-04-26 01:19:43 +08:00
Browse [lots more notable Discourse instances ](https://www.discourse.org/customers ).
2014-02-22 16:56:30 +08:00
2014-04-23 18:08:22 +08:00
## Development
2013-02-06 03:16:51 +08:00
2018-10-03 11:56:38 +08:00
To get your environment setup, follow the community setup guide for your operating system.
2013-02-06 03:16:51 +08:00
2018-10-03 11:56:38 +08:00
1. If you're on macOS, try the [macOS development guide ](https://meta.discourse.org/t/beginners-guide-to-install-discourse-on-macos-for-development/15772 ).
1. If you're on Ubuntu, try the [Ubuntu development guide ](https://meta.discourse.org/t/beginners-guide-to-install-discourse-on-ubuntu-for-development/14727 ).
1. If you're on Windows, try the [Windows 10 development guide ](https://meta.discourse.org/t/beginners-guide-to-install-discourse-on-windows-10-for-development/75149 ).
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** ](docs/DEVELOPER-ADVANCED.md ), which is aimed primarily at Ubuntu and macOS environments.
2013-03-18 01:59:24 +08:00
2020-03-12 15:27:23 +08:00
Before you get started, ensure you have the following minimum versions: [Ruby 2.6+ ](https://www.ruby-lang.org/en/downloads/ ), [PostgreSQL 10+ ](https://www.postgresql.org/download/ ), [Redis 4.0+ ](https://redis.io/download ). If you're having trouble, please see our [**TROUBLESHOOTING GUIDE** ](docs/TROUBLESHOOTING.md ) first!
2013-02-08 15:38:23 +08:00
2015-09-24 14:24:45 +08:00
## Setting up Discourse
2013-07-01 20:00:55 +08:00
2014-03-02 14:56:15 +08:00
If you want to set up a Discourse forum for production use, see our [**Discourse Install Guide** ](docs/INSTALL.md ).
2015-09-24 14:20:58 +08:00
If you're looking for business class hosting, see [discourse.org/buy ](https://www.discourse.org/buy/ ).
2013-07-01 20:00:55 +08:00
2014-03-01 16:40:35 +08:00
## Requirements
2013-02-06 03:16:51 +08:00
2020-01-08 01:20:46 +08:00
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:
2013-02-06 03:16:51 +08:00
2018-10-01 12:12:52 +08:00
| Browsers | Tablets | Phones |
| --------------------- | ------------ | ------------ |
2020-01-08 01:20:46 +08:00
| Apple Safari | iPadOS | iOS |
| Google Chrome | Android | Android |
| Microsoft Edge | | |
| Mozilla Firefox | | |
2014-03-02 15:03:08 +08:00
2013-04-11 12:47:45 +08:00
## Built With
2014-04-23 18:08:22 +08:00
- [Ruby on Rails ](https://github.com/rails/rails ) — Our back end API is a Rails app. It responds to requests RESTfully in JSON.
2014-03-02 15:05:15 +08:00
- [Ember.js ](https://github.com/emberjs/ember.js ) — Our front end is an Ember.js app that communicates with the Rails API.
2019-02-22 23:29:27 +08:00
- [PostgreSQL ](https://www.postgresql.org/ ) — Our main data store is in Postgres.
- [Redis ](https://redis.io/ ) — We use Redis as a cache and for transient data.
2013-04-11 12:47:45 +08:00
2014-01-15 09:34:13 +08:00
Plus *lots* of Ruby Gems, a complete list of which is at [/master/Gemfile ](https://github.com/discourse/discourse/blob/master/Gemfile ).
2013-04-11 12:47:45 +08:00
2013-02-06 03:16:51 +08:00
## Contributing
2020-04-24 00:34:25 +08:00
[](https://github.com/discourse/discourse/actions)
2013-02-08 05:46:06 +08:00
2015-09-24 14:24:45 +08:00
Discourse is **100% free** and **open source** . We encourage and support an active, healthy community that
2014-04-23 18:39:42 +08:00
accepts contributions from the public – including you!
2013-02-06 03:16:51 +08:00
2014-03-02 06:56:09 +08:00
Before contributing to Discourse:
2013-02-06 03:16:51 +08:00
2019-02-22 23:29:27 +08:00
1. Please read the complete mission statements on [**discourse.org** ](https://www.discourse.org ). Yes we actually believe this stuff; you should too.
2. Read and sign the [**Electronic Discourse Forums Contribution License Agreement** ](https://www.discourse.org/cla ).
2014-03-02 14:56:15 +08:00
3. Dig into [**CONTRIBUTING.MD** ](CONTRIBUTING.md ), which covers submitting bugs, requesting new features, preparing your code for a pull request, etc.
2015-12-04 19:14:45 +08:00
4. Always strive to collaborate [with mutual respect ](https://github.com/discourse/discourse/blob/master/docs/code-of-conduct.md ).
2019-02-22 23:29:27 +08:00
5. Not sure what to work on? [**We've got some ideas.** ](https://meta.discourse.org/t/so-you-want-to-help-out-with-discourse/3823 )
2015-12-04 19:14:45 +08:00
2013-02-06 03:16:51 +08:00
2014-03-01 16:40:35 +08:00
We look forward to seeing your pull requests!
2013-03-01 02:58:45 +08:00
2014-05-01 11:20:05 +08:00
## Security
2015-09-24 14:24:45 +08:00
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, or if you wish to report a security issue.
2014-05-01 11:20:05 +08:00
2013-02-06 03:16:51 +08:00
## The Discourse Team
2019-02-22 23:29:27 +08:00
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 ](https://blog.discourse.org/2013/02/the-discourse-team/ ) and [GitHub's list of contributors ](https://github.com/discourse/discourse/contributors ).
2013-04-11 12:45:31 +08:00
2013-02-06 03:16:51 +08:00
## Copyright / License
2020-03-13 06:54:30 +08:00
Copyright 2014 - 2020 Civilized Discourse Construction Kit, Inc.
2013-02-06 03:16:51 +08:00
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:
2019-02-22 23:29:27 +08:00
https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
2013-02-06 03:16:51 +08:00
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.
2013-02-27 17:14:44 +08:00
Discourse logo and “Discourse Forum” ®, Civilized Discourse Construction Kit, Inc.
## Dedication
2019-02-22 23:29:27 +08:00
Discourse is built with [love, Internet style. ](https://www.youtube.com/watch?v=Xe1TZaElTAs )
