mirror of
https://github.com/hanzoai/forum.git
synced 2026-09-30 21:51:19 +00:00
docs(readme): say this is a tracking fork, not a product
The README was Discourse's, verbatim: their logo, their mission, their team, their accessibility contact — and a hosting pitch linking to discourse.org/pricing, which sent anyone landing here to a third party's checkout. Read as ours it claims a community platform we do not run; forum.hanzo.ai 404s and the only Hanzo commits on the fork are CI, a hero banner and agent docs. Now says what it is: a tracking fork of Discourse with nothing built on top, nothing deployed, where to go for Discourse and where to go for Hanzo. Kept the upstream dev-setup links, which are the ones that actually apply. Lineage and GPL-2.0 attribution kept and made explicit.
This commit is contained in:
@@ -1,139 +1,40 @@
|
||||
<p align="center"><img src=".github/hero.svg" alt="forum" width="880"></p>
|
||||
|
||||
<a href="https://www.discourse.org/">
|
||||
<img src="images/discourse-readme-logo.png" width="300px">
|
||||
</a>
|
||||
# hanzoai/forum
|
||||
|
||||
The online home for your community.
|
||||
A tracking fork of [Discourse](https://github.com/discourse/discourse), kept for a future
|
||||
Hanzo community forum.
|
||||
|
||||
|
||||
## Status
|
||||
|
||||
Nothing Hanzo-specific has been built on top of it yet, and nothing is deployed. The
|
||||
commits on this fork are CI, branding assets and agent docs; the application code is
|
||||
upstream's. If you are looking for a running Hanzo forum, there isn't one — start at
|
||||
[docs.hanzo.ai](https://docs.hanzo.ai/docs), or open an issue on the repository you have a
|
||||
question about under [github.com/hanzoai](https://github.com/hanzoai).
|
||||
|
||||
> You can self-host Discourse on your own infrastructure. But if you'd rather skip the setup, maintenance, and server management, we offer official Discourse hosting.
|
||||
>
|
||||
> 👉 Learn more about [Discourse hosting](https://discourse.org/pricing)
|
||||
If you want to run Discourse, or you have a Discourse question, go to
|
||||
[discourse.org](https://www.discourse.org) and
|
||||
[meta.discourse.org](https://meta.discourse.org). They maintain it; we only track it.
|
||||
|
||||
Discourse is a 100% open-source community platform for those who want complete control over how and where their site is run.
|
||||
## Working on this fork
|
||||
|
||||
Our platform has been battle-tested for over a decade and continues to evolve to meet users’ needs for a powerful community platform.
|
||||
|
||||
**With Discourse, you can:**
|
||||
|
||||
* 💬 **Create discussion topics** to foster meaningful conversations.
|
||||
|
||||
* ⚡️ **Connect in real-time** with built-in chat.
|
||||
|
||||
* 🎨 **Customize your experience** with an ever-growing selection of official and community themes.
|
||||
|
||||
* 🤖 **Enhance your community** with plugins, from chatbots powered by [Discourse AI](https://meta.discourse.org/t/discourse-ai/259214) to advanced tools like SQL analysis with the [Data Explorer](https://meta.discourse.org/t/discourse-data-explorer/32566) plugin.
|
||||
|
||||
To learn more, visit [discourse.org](https://www.discourse.org/) and join our support community at [meta.discourse.org](https://meta.discourse.org/).
|
||||
|
||||
|
||||
Here are just a few of the incredible communities using Discourse:
|
||||
|
||||
|
||||
|
||||
👉 [Discover more communities using Discourse](https://discover.discourse.org/)
|
||||
|
||||
|
||||
## Development
|
||||
|
||||
To get your environment set up, follow one of the setup guides:
|
||||
The upstream setup guides apply unchanged — Ruby 3.2+, PostgreSQL 13, Redis 7:
|
||||
|
||||
- [Docker / Dev Container](https://meta.discourse.org/t/336366)
|
||||
- [macOS](https://meta.discourse.org/t/15772)
|
||||
- [Ubuntu/Debian](https://meta.discourse.org/t/14727)
|
||||
- [Ubuntu / Debian](https://meta.discourse.org/t/14727)
|
||||
- [Windows](https://meta.discourse.org/t/75149)
|
||||
|
||||
Before you get started, ensure you have the following minimum versions: [Ruby 3.2+](https://www.ruby-lang.org/en/downloads/), [PostgreSQL 13](https://www.postgresql.org/download/), [Redis 7](https://redis.io/download).
|
||||
Production install: [`docs/INSTALL.md`](docs/INSTALL.md).
|
||||
|
||||
For more information, check out [the Developer Documentation](https://meta.discourse.org/c/documentation/developer-guides/56).
|
||||
Changes that belong upstream should go upstream — send them to
|
||||
[discourse/discourse](https://github.com/discourse/discourse) rather than here, so this
|
||||
fork stays easy to rebase.
|
||||
|
||||
## 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 official hosting, see [discourse.org/pricing](https://www.discourse.org/pricing/).
|
||||
|
||||
## Requirements
|
||||
|
||||
Discourse supports the **latest, stable releases** of all major browsers and platforms:
|
||||
|
||||
| Browsers | Tablets | Phones |
|
||||
| --------------------- | ------------ | ------------ |
|
||||
| Apple Safari | iPadOS | iOS |
|
||||
| Google Chrome | Android | Android |
|
||||
| Microsoft Edge | | |
|
||||
| Mozilla Firefox | | |
|
||||
|
||||
Additionally, we aim to support Safari on iOS 15.7+.
|
||||
|
||||
## 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](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.
|
||||
- [BrowserStack](https://www.browserstack.com/) — We use BrowserStack to test on real devices and browsers.
|
||||
|
||||
Plus *lots* of Ruby Gems, a complete list of which is at [/main/Gemfile](https://github.com/discourse/discourse/blob/main/Gemfile).
|
||||
|
||||
## Contributing
|
||||
|
||||
[](https://github.com/discourse/discourse/actions)
|
||||
|
||||
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**](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).
|
||||
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/main/docs/code-of-conduct.md).
|
||||
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)
|
||||
|
||||
|
||||
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/main/docs/SECURITY.md) for an overview of security measures in Discourse, or if you wish to report a security issue.
|
||||
|
||||
Security fixes are listed in the [release notes](https://meta.discourse.org/tags/c/announcements/67/release-notes) for each version.
|
||||
|
||||
## 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](https://blog.discourse.org/2013/02/the-discourse-team/) and [GitHub's list of contributors](https://github.com/discourse/discourse/contributors).
|
||||
|
||||
## Copyright / License
|
||||
|
||||
Copyright 2014 - 2025 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:
|
||||
|
||||
https://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.
|
||||
|
||||
## Accessibility
|
||||
|
||||
To guide our ongoing effort to build accessible software we follow the [W3C’s Web Content Accessibility Guidelines (WCAG)](https://www.w3.org/TR/WCAG21/). If you'd like to report an accessibility issue that makes it difficult for you to use Discourse, email accessibility@discourse.org. For more information visit [discourse.org/accessibility](https://discourse.org/accessibility).
|
||||
|
||||
## Dedication
|
||||
|
||||
Discourse is built with [love, Internet style.](https://www.youtube.com/watch?v=Xe1TZaElTAs)
|
||||
|
||||
For over a decade, our [amazing community](https://meta.discourse.org/) has helped shape Discourse into what it is today. Your support, feedback, and contributions have been invaluable in making Discourse a powerful and versatile platform.
|
||||
|
||||
We’re deeply grateful for every feature request, bug report, and discussion that has driven Discourse forward. Thank you for being a part of this journey—we couldn’t have done it without you!
|
||||
## Lineage and license
|
||||
|
||||
Discourse, copyright 2014–2025 Civilized Discourse Construction Kit, Inc., licensed
|
||||
GPL-2.0-or-later. This fork keeps that licence; see [LICENSE](LICENSE). The Discourse logo
|
||||
and "Discourse Forum" are their trademarks, and this fork is not affiliated with or
|
||||
endorsed by them.
|
||||
|
||||
Reference in New Issue
Block a user