github
/
flarum
mirror of https://github.com/flarum/flarum
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
146 Commits
5 Branches
28 Tags
9.5 MiB
PHP 100%
 
Go to file
Franz Liedke 56fb00378c Use new method for retrieving base URL 2015-08-27 00:48:54 +02:00
assets New skeleton architecture 2015-04-25 22:57:04 +09:30
extensions Ignore extensions 2015-06-17 10:33:10 +09:30
flarum Clean up, add header comments 2015-08-26 17:13:18 +09:30
.editorconfig Add editorconfig 2015-05-06 11:26:36 +09:30
.gitattributes Add .gitattributes 2015-08-13 13:08:16 +09:30
.gitignore Ignore PHPStorm stuff 2015-07-04 12:26:17 +09:30
.gitmodules Rename system directory to flarum 2015-08-12 17:17:13 +09:30
.htaccess Use better way of ensuring Authorization header 2015-08-26 17:12:47 +09:30
CONTRIBUTING.md Revamp readme/contributing 2015-05-07 12:43:49 +09:30
LICENSE Clean up, add header comments 2015-08-26 17:13:18 +09:30
Vagrantfile Clean up, add header comments 2015-08-26 17:13:18 +09:30
admin.php Use new method for retrieving base URL 2015-08-27 00:48:54 +02:00
api.php Use new method for retrieving base URL 2015-08-27 00:48:54 +02:00
build.sh Actually zip up the release 2015-08-26 23:15:45 +02:00
index.php Use new method for retrieving base URL 2015-08-27 00:48:54 +02:00
readme.md Remove that message, it doesn't tell the full story 2015-05-28 22:50:40 +09:30

readme.md

Flarum

Delightfully simple forums. Flarum is the next-generation forum software that makes online discussion fun again.

Live Demo - Development Forum - Twitter - Contact - Donate

Gitter

Goals

  • Fast and simple. No clutter, no bloat, no complex dependencies. Flarum is built with PHP so it's quick and easy to deploy. The interface is powered by Mithril, a highly performant JavaScript framework with a tiny footprint.
  • Beautiful and responsive. This is forum software for humans. Flarum is carefully designed to be consistent and intuitive across platforms, out-of-the-box. It's backed by LESS, so themeing is a cinch.
  • Powerful and extensible. Customize, extend, and integrate Flarum to suit your community. Flarum's architecture is amazingly flexible, prioritizing comprehensive APIs and great documentation.
  • Free and open. Flarum is released under the MIT license.

Installation

Flarum is currently in development and will be ready to use later this year. (Roadmap) If you want to give the development version a spin or are interested in contributing, for now you can install Flarum's Vagrant image. An easier installation process will become a priority once Flarum is more stable.

  1. Install Vagrant and VirtualBox.
  2. Clone this repository and set up the Vagrant box:
git clone --recursive https://github.com/flarum/flarum.git
cd flarum
vagrant up
  1. Add an entry to your /etc/hosts file:

192.168.29.29 flarum.dev

  1. Visit flarum.dev in a browser.

Contributing

Interested in contributing to Flarum? Read the Contribution Guide!

Bug reports should go in flarum/core or the relevant extension repository.

Core Team