github
/
flarum
mirror of https://github.com/flarum/flarum
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
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.
94 Commits
5 Branches
26 Tags
9.5 MiB
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'a0ef02e4f6'
${ noResults }
Go to file
Franz Liedke a0ef02e4f6
Use Whoops in debug mode, JSON API compliant errors otherwise 		10 years ago
assets New skeleton architecture 10 years ago
extensions Ignore extensions 10 years ago
system Rename command line tool 10 years ago
.editorconfig Add editorconfig 10 years ago
.gitignore Delete config.php, replace it by example file. 10 years ago
.gitmodules Add flarum/core as submodule 10 years ago
CONTRIBUTING.md Revamp readme/contributing 10 years ago
LICENSE.txt Add license 10 years ago
Vagrantfile Back to nginx for now, split up index/admin entries 10 years ago
admin.php Load extensions after other service providers 10 years ago
api.php Use Whoops in debug mode, JSON API compliant errors otherwise 10 years ago
config.example.php Delete config.php, replace it by example file. 10 years ago
index.php Load extensions after other service providers 10 years ago
readme.md Remove that message, it doesn't tell the full story 10 years ago

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