mirror of https://github.com/flarum/flarum
4479d857b6
* Escape some quotes in environment.sh * Fix incompatibility between Vaprobash 1.4.2 where first parameter for composer.sh is now treated as a Github token Ref: https://github.com/fideloper/Vaprobash/pull/493 |
||
|---|---|---|
| assets | ||
| scripts | ||
| storage | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .htaccess | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| Procfile | ||
| Vagrantfile | ||
| admin.php | ||
| api.php | ||
| composer.json | ||
| flarum | ||
| index.php | ||
| readme.md | ||
readme.md
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
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.