mirror of
https://github.com/discourse/discourse.git
synced 2024-11-23 08:09:33 +08:00
130 lines
6.3 KiB
Markdown
130 lines
6.3 KiB
Markdown
<a href="http://www.discourse.org/"></a>
|
|
|
|
Discourse is the 100% open source, next-generation discussion platform built for the next decade of the Internet.
|
|
|
|
Whenever you need ...
|
|
|
|
- a mailing list
|
|
- a forum to discuss something
|
|
- a chat room where you can type paragraphs
|
|
|
|
... consider Discourse.
|
|
|
|
## Getting Started
|
|
|
|
If you're interested in helping us develop Discourse, please start with our [**Discourse Vagrant Developer Guide**](https://github.com/discourse/discourse/blob/master/docs/VAGRANT.md), which includes instructions to get up and running in a development environment using a virtual machine. It's the easiest way to hack on Discourse!
|
|
|
|
If you're familiar with how Rails works and are comfortable setting up your own environment, use our [**Discourse Advanced Developer Guide**](https://github.com/discourse/discourse/blob/master/docs/DEVELOPER-ADVANCED.md).
|
|
|
|
### Requirements
|
|
|
|
- [Ruby 1.9.3+](http://www.ruby-lang.org/en/downloads/)
|
|
- [PostgreSQL 9.1+](http://www.postgresql.org/download/)
|
|
- [Redis 2.6+](http://redis.io/download)
|
|
|
|
## Vision
|
|
|
|
Discourse is a **Civilized Discourse Construction Kit**, an 100% open-source discussion platform that is free for everyone to use and contribute to -- forever.
|
|
|
|
Key Discourse mission goals:
|
|
|
|
- A **flattened, endlessly scrolling discussion**, avoiding the akwardness of traditionally threaded and paginated discussion, while allowing replies to be expanded in place for additional context.
|
|
|
|
- A **user trust system** that grants users additional rights to assist in moderating the forum as they participate in good faith over time. The goal is for the forum to be nearly self-moderating in the absence of any formal moderators, although excellent moderators accelerate the process greatly.
|
|
|
|
- An **advanced JavaScript app** which runs in modern browsers and works identically on desktop and tablet, without the need for a native app.
|
|
|
|
- A **contemporary, robust technology stack**, free of legacy PHP and MySQL constraints limiting developers and administrators.
|
|
|
|
The Discourse team wishes to **foster an active community of contributors**, all of whom commit to delivering this continued vision, ensuring that free, unfettered online discussion can grow and thrive in an Internet age dominated by micro-blogging, and diminishing attention spans. Online discussion belongs to all of us, not just huge corporate websites.
|
|
|
|
This vision translates to the following functional commitments:
|
|
|
|
1. Support only modern browsers on the desktop:
|
|
- Internet Explorer 9.0, 10.0+
|
|
- Firefox 16+
|
|
- Google Chrome 23+
|
|
- Safari 5+
|
|
2. Support the latest generation of tablets, 7" or larger
|
|
- iPad 2+
|
|
- Android 4.1+
|
|
- Windows 8
|
|
3. Deliver support for the latest generation of small screen mobile/smartphones *as soon as possible*:
|
|
- Windows Phone 8
|
|
- iOS 5+
|
|
- Android 4.0+
|
|
|
|
## 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, and we'd like you to be a part of that community.
|
|
|
|
Before contributing to Discourse, please:
|
|
|
|
1. Review the [**VISION**](#vision) section above, which will help you understand the needs of the team, and the focus of the project,
|
|
2. Read and sign the [**Electronic Discourse Forums Contribution License Agreement**](http://discourse.org/cla), to confirm you've read and acknowledged the legal aspects of your contributions, and
|
|
3. Dig into [**CONTRIBUTING.MD**](https://github.com/discourse/discourse/blob/master/docs/CONTRIBUTING.md), which houses all of the necessary info to:
|
|
- submit bugs,
|
|
- request new features, and
|
|
- step you through the entire process of preparing your code for a Pull Request.
|
|
4. Have a look here: http://meta.discourse.org/t/so-you-want-to-help-out-with-discourse/3823
|
|
|
|
**We look forward to seeing your cool stuff!**
|
|
|
|
## Expertise
|
|
|
|
In order to be an effective contributor, familiarize yourself with the various open source components that Discourse is built on:
|
|
|
|
### Languages/Frameworks
|
|
|
|
1. [Ruby on Rails](https://github.com/rails/rails) - Our back end API is a Rails app. It responds to requests RESTfully and responds in JSON.
|
|
2. [Ember.js](https://github.com/emberjs/ember.js) - Our front end interface is an Ember.js app that communicates with the Rails API.
|
|
|
|
### Databases
|
|
|
|
1. [PostgreSQL](http://www.postgresql.org/) - Our main data store is Postgres.
|
|
2. [Redis](http://redis.io/) - We use Redis for our job queue, rate limiting, as a cache and for transient data.
|
|
|
|
### Ruby Gems
|
|
|
|
The complete list of Ruby Gems used by Discourse can be found in [**SOFTWARE.MD**](https://github.com/discourse/discourse/blob/master/docs/SOFTWARE.md).
|
|
|
|
## Versioning
|
|
|
|
Discourse implements the Semantic Versioning guidelines.
|
|
|
|
Releases will be numbered with the following format:
|
|
|
|
`<major>.<minor>.<patch>`
|
|
|
|
And constructed with the following guidelines:
|
|
|
|
- Breaking backward compatibility bumps the major (and resets the minor and patch)
|
|
- New additions without breaking backward compatibility bumps the minor (and resets the patch)
|
|
- Bug fixes and misc changes bumps the patch
|
|
|
|
For more information on SemVer, please visit http://semver.org/.
|
|
|
|
## The Discourse Team
|
|
|
|
The Discourse code contributors can be found in [**AUTHORS.MD**](https://github.com/discourse/discourse/blob/master/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 website.
|
|
|
|
## Copyright / License
|
|
|
|
Copyright 2013 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.
|