Skip to content
[NOT-EXT] Create a Flarum extension from a boilerplate in minutes!
JavaScript PHP
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE
boilerplate
src
.gitignore
CHANGELOG.md
README.md
package.json

README.md

Create Flarum Extension by FriendsOfFlarum

npm version node npm downloads OpenCollective Patreon

Create a Flarum extension from a boilerplate in minutes!

asciicast

Quick Overview

Using npx (npx comes with npm 5.2+ and higher):

npx @friendsofflarum/create-flarum-extension [dir]

Normally:

npm install -g @friendsofflarum/create-flarum-extension
create-flarum-extension [dir]

Creating an Extension

You’ll need to have Node >= 8 on your local development machine. You can use n to interactively manage your node versions.

To create a new app, run a single command:

npx @friendsofflarum/create-flarum-extension my-extension

(npx comes with npm 5.2+ and higher, see quick overview for older npm versions)

It will create a directory called my-extension inside the current folder. Inside that directory, it will generate the initial project structure:

my-extension
├── .gitignore
├── bootstrap.php
├── composer.json
├── LICENSE.md
├── README.md
├── js
│  ├── admin.js
│  ├── forum.js
│  ├── package.json
│  ├── src
│  │  ├── admin
│  │  │  └── index.js
│  │  └── forum
│  │     └── index.js
│  └── webpack.config.js
└── resources
   ├── less
   │  ├── admin.less
   │  └── forum.less
   └── locale
      └── en.yml

Flarum Resources

Links

A utility by FriendsOfFlarum.

You can’t perform that action at this time.