mirror of
https://github.com/discourse/discourse.git
synced 2024-11-27 01:33:38 +08:00
b800833ddc
The old "Discourse as your first rails app" blog post points people in the direction of Vagrant, which is no longer maintained. That blog post now points people in the direction of guides that have been wiki-fied on Meta, which can also be replied to if there are questions. The existing setup guides appear to be relevant still, but the community wikis are probably better for new people to reference. If you ask me, though, there's a great debate here about whether or not setup documentation should live in this repo or on Meta -- but I don't have the answer for that. It's more important to get the effectively dead guide off the front page, since it's Hacktoberfest and I'm sure people want to contribute, but need a clear starting point.
109 lines
6.2 KiB
Markdown
109 lines
6.2 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. 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**](http://www.discourse.org).
|
|
|
|
## Screenshots
|
|
|
|
|
|
<a href="https://bbs.boingboing.net"><img alt="Boing Boing" src="https://cloud.githubusercontent.com/assets/1385470/25397876/3fe6cdac-29c0-11e7-8a41-9d0c0279f5a3.png" width="720px"></a>
|
|
<a href="https://twittercommunity.com/"><img src="https://cloud.githubusercontent.com/assets/1385470/25397920/71b24e4c-29c0-11e7-8bcf-7a47b888412e.png" width="720px"></a>
|
|
<a href="http://discuss.howtogeek.com"><img src="https://cloud.githubusercontent.com/assets/1385470/25398049/f0995962-29c0-11e7-99d7-a3b9c4f0b357.png" width="720px"></a>
|
|
<a href="https://talk.turtlerockstudios.com/"><img src="https://cloud.githubusercontent.com/assets/1385470/25398115/2d560d96-29c1-11e7-9a96-b0134a4fedff.png" width="720px"></a>
|
|
|
|
<img src="https://www.discourse.org/a/img/about/mobile-devices-2x.jpg" alt="Mobile" width="414">
|
|
|
|
Browse [lots more notable Discourse instances](https://www.discourse.org/customers).
|
|
|
|
## 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](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.
|
|
|
|
Before you get started, ensure you have the following minimum versions: [Ruby 2.4+](http://www.ruby-lang.org/en/downloads/), [PostgreSQL 10+](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 Discourse
|
|
|
|
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](https://www.discourse.org/buy/).
|
|
|
|
## Requirements
|
|
|
|
Discourse is built for the *next* 10 years of the Internet, so our requirements are high:
|
|
|
|
| Browsers | Tablets | Phones |
|
|
| --------------------- | ------------ | ------------ |
|
|
| Safari 6.1+ | iPad 3+ | iOS 8+ |
|
|
| Google Chrome 32+ | Android 4.3+ | Android 4.3+ |
|
|
| Internet Explorer 11+ | | |
|
|
| Firefox 27+ | | |
|
|
|
|
## 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)
|
|
|
|
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. Always strive to collaborate [with mutual respect](https://github.com/discourse/discourse/blob/master/docs/code-of-conduct.md).
|
|
5. 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, or if you wish to report a security issue.
|
|
|
|
## 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 - 2018 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)
|