You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Toby Zerner 18c471f015 Add beta stability flags 9 years ago
assets
extensions
scripts Add rules for compression and cache expiry 9 years ago
storage Add temporary file storage dir 9 years ago
.editorconfig
.gitattributes
.gitignore Ignore composer lock file for now 9 years ago
.htaccess Fix Apache configuration error, blacklist some files 9 years ago
CONTRIBUTING.md Update docs for beta 3 9 years ago
LICENSE
Vagrantfile New Composer-driven app skeleton 9 years ago
admin.php Split up front controllers again 9 years ago
api.php Split up front controllers again 9 years ago
composer.json Add beta stability flags 9 years ago
flarum Split up front controllers again 9 years ago
index.php Split up front controllers again 9 years ago
readme.md Add beta stability flags 9 years ago

readme.md

Flarum

Flarum is free, open-source forum software built with PHP and Mithril.js. It is:

  • Simple, with a responsive UI that is optimized for touch devices
  • Fast, with a total JS payload size of ~130 KB gzipped
  • Extensible, so you can tailor it to your use-case

screenshot

Installation

Flarum is currently in beta and should not be used in production. It is being developed openly on GitHub. Check out the Roadmap to follow along with our progress.

You must have SSH access to a server with PHP 5.5+ and MySQL 5.5+, and install Composer.

composer create-project flarum/flarum . --stability=beta

Read the Installation Guide for more information.

Support

Refer to the FAQ, Documentation, and ask questions on the Community Forum or Gitter Chat.

Contributing

Flarum is open-source and we would love your help building it! Please read the Contributing Guide to learn how you can help.

License

Copyright (c) 2015 Toby Zerner. Code released under the MIT License.