A platform for community discussion. Free, open, simple.
Go to file
Jeff Wong d208396c5c
UX: improve touch, swipe, panning performance on mobile menus (#23775)
PERF: improve touch, swipe, panning performance on mobile menus
---

* stop event propagation on swipe events: other touch events were stealing a huge amount of time here. Stop event
propagation when handling pan events.
* animate with [web animations api](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API/Using_the_Web_Animations_API)
* prefer translate3d to hint for gpu rendering.
* query document for elements only on start move event, not on subsequent move
events
* remove unused calculations for directioned velocity and distance: all swipe/pan elements function in x/y direction only.
* re-implement scroll locking behavior.

re-implemented scroll lock behavior
---

With stop event propagation, we need to re-implement scroll locking on menu swipes.
Previously, this was using onTouchMove which was costly.

We may now use styling with overflow-y:hidden to lock scroll behavior.

overflow:hidden on html/body elements is now supported by iOS as of 2022
https://bugs.webkit.org/show_bug.cgi?id=153852
https://bugs.webkit.org/show_bug.cgi?id=220908

UX: improve swipe
---

Some improvements to get gestures and swipes feeling a little more polished.

This focuses on end gesture, and how we transfer it to a css animation to
complete a menu open/close action.

Multitouch: events may pan, scroll, and zoom - especially on iOS safari.
Cancelling the swipe event allows for a more pleasant zooming experience.

* ease-out on menus opening, linear on close
* calculate animation duration for opening and closing,
attempt to better transfer user swipe velocity to css animation.
* more timely close/open and cleanup from calculated animation timing.
* add animation to closing menus on cloak tap
* correctly animate menus with ease-in and ease-out
* add swipe cancel event on multitouch event

DEV
---

* lean on promises

js animations api gives us promises to listen to. Update test waiters
to use waitForPromise from @ember/test-waiters instead of reigster/unregister.

* convert swipe mixin to its own class.

Convert swipe callbacks to custom events on the element.
Move shared functions for max animation time and close logic to
new shared class.

swipe-events lib uses custom events to trigger callbacks, rather than assuming
implemented hard coded function from the mixin's base class. Custom events are
triggered from the bound element as swipestart, swipeend, swipe

Add shared convenience functions for swipe events so they can be more easily
shared.

A client receives an initial swipe event and can check some state to see if it
wants to handle the swipe event and if it doesn't, calling
`event.preventDefault();` will prevent `swipe` and `swipeend` events from firing
until another distinct swipestart event is fired. Swipe events will auto-cancel on multitouch.

The scroll lock has also exposed as its own utility class.
2023-10-16 11:27:00 -07:00
.devcontainer DEV: Replace postCreateCommand with postStartCommand (#16665) 2022-05-05 23:52:35 +02:00
.github DEV: Write execution file for test failures (#23879) 2023-10-16 11:12:13 +01:00
.vscode-sample DEV: introduce Ember <template> tag support (.gjs) (#22719) 2023-07-20 21:01:12 +01:00
app UX: improve touch, swipe, panning performance on mobile menus (#23775) 2023-10-16 11:27:00 -07:00
bin DEV: Allow explicitly enabling/disabling system tests in bin/turbo_rspec (#23515) 2023-09-11 13:11:06 -05:00
config SECURITY: Add a default limit as to when logs should be truncated 2023-10-16 10:34:38 -04:00
db FEATURE: granular webhooks (#23070) 2023-10-09 03:35:31 +00:00
docs DEV: Improve addToolbarPopupMenuOptionsCallback plugin api (#23769) 2023-10-06 07:43:40 +08:00
documentation DEV: Fix random typos (#20937) 2023-04-03 19:27:32 +02:00
images Replace README logo with PNG (#14044) 2021-08-13 14:23:49 -04:00
lib Bump version to v3.2.0.beta3-dev 2023-10-16 11:20:22 -04:00
log Initial release of Discourse 2013-02-05 14:16:51 -05:00
migrations DEV: Add initial structure for migrations-tooling 2023-10-13 16:03:55 +02:00
plugins FIX: do not serialize status when profile is hidden (#23946) 2023-10-16 17:43:39 +02:00
public DEV: Fix random typos (#23801) 2023-10-05 20:40:53 +02:00
script DEV: Update importers from PostUpload to UploadReference (#23681) 2023-09-27 15:01:04 +01:00
spec UX: improve touch, swipe, panning performance on mobile menus (#23775) 2023-10-16 11:27:00 -07:00
test DEV: Drop /theme-qunit from smoke test (#23562) 2023-09-13 16:14:27 +01:00
vendor DEV: FloatKit (#23650) 2023-09-26 13:39:52 +02:00
.editorconfig DEV: Update .editorconfig to match new hbs rules (#19816) 2023-01-10 16:21:16 +01:00
.eslintignore DEV: convert I18n pseudo package into real package (discourse-i18n) (#23867) 2023-10-12 14:44:01 +01:00
.eslintrc DEV: Update linting setup (#23434) 2023-09-06 14:23:06 +02:00
.git-blame-ignore-revs DEV: Add recent formatting commits to .git-blame-ignore-revs (#19799) 2023-01-09 14:51:48 +00:00
.gitattributes DEV: introduce Ember <template> tag support (.gjs) (#22719) 2023-07-20 21:01:12 +01:00
.gitignore DEV: Add gjs support for themes (#23473) 2023-10-02 12:36:06 +02:00
.jsdoc DEV: Chat service object initial implementation (#19814) 2023-02-13 13:09:57 +01:00
.licensed.yml Build(deps): Bump faraday from 2.7.10 to 2.7.11 (#23554) 2023-09-14 01:33:44 +02:00
.licensee.json DEV: Update eslint/prettier (#22226) 2023-06-21 20:59:03 +02:00
.npmrc DEV: Prevent npm usage (#13945) 2021-08-04 22:04:58 +02:00
.prettierignore DEV: convert I18n pseudo package into real package (discourse-i18n) (#23867) 2023-10-12 14:44:01 +01:00
.prettierrc DEV: introduce Ember <template> tag support (.gjs) (#22719) 2023-07-20 21:01:12 +01:00
.rspec Add RSpec 4 compatibility (#17652) 2022-07-28 10:27:38 +08:00
.rspec_parallel DEV: Introduce parallel rspec testing 2019-04-01 11:06:47 -04:00
.rubocop.yml DEV: Enable unless cops 2023-02-21 10:30:48 +01:00
.ruby-gemset.sample rvm has offically depreicated .rvmrc and recommends using .ruby-version and .ruby-gemset instead. 2013-05-23 09:16:11 -07:00
.ruby-version.sample DEV: Update recommended Ruby to 3.2.1 (#20444) 2023-02-24 12:51:34 -03:00
.streerc DEV: Apply syntax_tree formatting to app/* 2023-01-09 14:14:59 +00:00
.template-lintrc.js DEV: Introduce declarative hide-application-footer helper (#23088) 2023-08-17 12:47:08 +01:00
Brewfile DEV: enable frozen string literal on all files 2019-05-13 09:31:32 +08:00
CODEOWNERS DEV: Add codeowner for migrations related code 2023-10-13 16:03:55 +02:00
config.ru DEV: enable frozen string literal on all files 2019-05-13 09:31:32 +08:00
CONTRIBUTING.md Proper long form for CLA 2015-09-10 20:49:03 +02:00
COPYRIGHT.md DEV: Absorb onebox gem into core (#12979) 2021-05-26 15:11:35 +05:30
d add wrappers for mailcatcher and sidekiq 2016-12-13 09:05:45 +11:00
discourse.sublime-project DEV: Exclude i18n .yml files from Sublime Text project. (#6473) 2018-10-10 20:21:24 +08:00
Gemfile DEV: Remove dependence on dartsass-sprockets (#23665) 2023-09-26 16:25:07 +01:00
Gemfile.lock Build(deps-dev): Bump rubocop from 1.57.0 to 1.57.1 (#23937) 2023-10-16 11:24:12 +02:00
jsconfig.base.json DEV: introduce Ember <template> tag support (.gjs) (#22719) 2023-07-20 21:01:12 +01:00
lefthook.yml DEV: Add syntax_tree check to lefthook (#19877) 2023-01-17 10:16:07 +10:00
LICENSE.txt DEV: Absorb onebox gem into core (#12979) 2021-05-26 15:11:35 +05:30
package.json DEV: Sort imports 2023-10-10 21:46:54 +01:00
Rakefile FIX: Do not dump schema during production database migrations (#12785) 2021-04-21 16:26:20 +01:00
README.md FIX: correct link to meta.discourse.org 2023-08-29 13:17:05 +02:00
translator.yml FEATURE: Bundle discourse-checklist plugin into core (#22927) 2023-08-02 10:17:24 +01:00
yarn.lock DEV: Update eslint-config-discourse 2023-10-10 21:46:54 +01:00

Discourse is the online home for your community. We offer a 100% open source community platform to those who want complete control over how and where their site is run.

Our platform has been battle-tested for over a decade and continues to evolve to meet users needs for a powerful community platform. Discourse allows you to create discussion topics and connect using real-time chat, as well as access an ever-growing number of official and community themes. In addition, we offer a wide variety of plugins for features ranging from chatbots powered by Discourse AI to functionalities like SQL analysis using the Data Explorer plugin.

To learn more, visit discourse.org and join our support community at meta.discourse.org.

Screenshots

Discourse 3.1

Boing Boing

Mobile

Browse lots more notable Discourse instances.

Development

To get your environment set up, follow the community setup guide for your operating system.

  1. If you're on macOS, try the macOS development guide.
  2. If you're on Ubuntu, try the Ubuntu development guide.
  3. If you're on Windows, try the Windows 10 development guide.
  4. If you're looking to use a simpler Docker-based install, try the Docker development guide.

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, which is aimed primarily at Ubuntu and macOS environments.

Before you get started, ensure you have the following minimum versions: Ruby 3.2+, PostgreSQL 13, Redis 7. If you're having trouble, please see our TROUBLESHOOTING GUIDE first!

Setting up Discourse

If you want to set up a Discourse forum for production use, see our Discourse Install Guide.

If you're looking for official hosting, see discourse.org/pricing.

Requirements

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:

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 — Our back end API is a Rails app. It responds to requests RESTfully in JSON.
  • Ember.js — Our front end is an Ember.js app that communicates with the Rails API.
  • PostgreSQL — Our main data store is in Postgres.
  • Redis — We use Redis as a cache and for transient data.
  • BrowserStack — We use BrowserStack to test on real devices and browsers.

Plus lots of Ruby Gems, a complete list of which is at /main/Gemfile.

Contributing

Build Status

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. Yes we actually believe this stuff; you should too.
  2. Read and sign the Electronic Discourse Forums Contribution License Agreement.
  3. Dig into 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.
  5. Not sure what to work on? We've got some ideas.

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 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. For a complete list of the many individuals that contributed to the design and implementation of Discourse, please refer to the official Discourse blog and GitHub's list of contributors.

Copyright 2014 - 2023 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 W3Cs Web Content Accessibility Guidelines (WCAG). 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.

Dedication

Discourse is built with love, Internet style.