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.
Franz Liedke 84f8ef0395
Add version constraint for http-interop interfaces
7 years ago
public Rules no longer necessary with the public folder 7 years ago
storage Add folder for locale cache 7 years ago
.editorconfig Remove redundant options 9 years ago
.gitattributes Add .gitattributes 9 years ago
.gitignore Ignore composer lock file for now 9 years ago
CONTRIBUTING.md Add links to dev discussions 7 years ago
LICENSE Update license year (#47) 7 years ago
composer.json Add version constraint for http-interop interfaces 7 years ago
flarum Use new Site class to bootstrap web server and console 7 years ago
readme.md Tweak readme text 7 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.

Development

This repository holds the Flarum skeleton application. Its dependencies, such as flarum/core (where most development happens), have to be installed using Composer.

Support

Refer to the FAQ, Documentation, and ask questions on the Community Forum or Discord 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.