mirror of https://github.com/flarum/flarum
34 lines
1.4 KiB
Markdown
34 lines
1.4 KiB
Markdown
|
|
|
|
**[Flarum](http://flarum.org) is free, open-source forum software** built with PHP and [Mithril.js](http://mithril.js.org). 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](http://flarum.org/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](https://getcomposer.org).
|
|
|
|
```
|
|
composer create-project flarum/flarum . --stability=beta
|
|
```
|
|
|
|
Read the [Installation Guide](http://flarum.org/docs/installation) for more information.
|
|
|
|
## Support
|
|
|
|
Refer to the [FAQ](http://flarum.org/docs/faq), [Documentation](http://flarum.org/docs), and ask questions on the [Community Forum](http://discuss.flarum.org) or [Gitter Chat](https://gitter.im/flarum/flarum).
|
|
|
|
## Contributing
|
|
|
|
Flarum is open-source and we would love your help building it! Please read the [Contributing Guide](https://github.com/flarum/flarum/blob/master/CONTRIBUTING.md) to learn how you can help.
|
|
|
|
## License
|
|
|
|
Copyright (c) 2015 Toby Zerner. Code released under the [MIT License](https://github.com/flarum/flarum/blob/master/LICENSE).
|