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 (but it’s not required on the server). You can use n to interactively manager 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
├── README.md
├── LICENSE.md
├── js
│ ├── admin
│ │ ├── Gulpfile.js
│ │ ├── package.json
│ │ └── src
│ │ └── main.js
│ └── forum
│ ├── Gulpfile.js
│ ├── package.json
│ └── src
│ └── main.js
├── less
│ ├── admin.less
│ └── app.less
├── locale
│ └── en.yml
└── src
└── Listeners
└── AddClientAssets.php
Links
A utility by FriendsOfFlarum.
