Create Flarum Extension by FriendsOfFlarum

Create a Flarum extension from a boilerplate in minutes!

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
├── .gitattributes
├── composer.json
├── extend.php
├── LICENSE.md
├── README.md
├── js
│  ├── admin.js
│  ├── forum.js
│  ├── package.json
│  ├── webpack.config.js
│  └── src
│     ├── admin
│     │  └── index.js
│     └── forum
│        └── index.js
└── resources
   ├── less
   │  ├── admin.less
   │  └── forum.less
   └── locale
      └── en.yml

Flarum Resources

• Unofficial Flarum API Docs - @datitisev
• Extension development - first read - @luceos
• Extension development - using composer - @luceos
• Extension development - different workflows
• Extension development - namespace tips

Links

• NPM
• GitHub

A utility by FriendsOfFlarum.