I don't know how to install the blank extension framework built with flarum/cli

shebaoting

I am learning how to develop extensions.
I have generated a basic framework using flarum/cli.
https://github.com/shebaoting/reward

Then I run the following command

composer require acme/flarum-hello-world *@dev

It fails. The error is:

➜  bbs git:(master) ✗ composer require shebaoting/reward *@dev
./composer.json has been updated
Running composer update shebaoting/reward
Loading composer repositories with package information
Updating dependencies
Your requirements could not be resolved to an installable set of packages.

  Problem 1
    - Root composer.json requires shebaoting/reward, it could not be found in any version, there may be a typo in the package name.

Potential causes:
 - A typo in the package name
 - The package is not available in a stable-enough version according to your minimum-stability setting
   see <https://getcomposer.org/doc/04-schema.md#minimum-stability> for more details.
 - It's a private package and you forgot to add a custom repository to find it

Read <https://getcomposer.org/doc/articles/troubleshooting.md> for further common problems.

Installation failed, reverting ./composer.json and ./composer.lock to their original content.

What should I do to fix it?

I really like flarum and I would like to learn how to develop flarum extensions, please help me out. Thank you all.

luceos

shebaoting composer require acme/flarum-hello-world *@dev

Try

composer require acme/flarum-hello-world:"*@dev"

SychO

did you run this https://docs.flarum.org/extend/start#extension-packaging and put your extension inside the packages folder?

Cactus1805

Did you submit your extension to https://packagist.org/ ? I had same problem with you just few day ago when I tried to public my first extension. After did some research on the internet, I found out that we need to submit the extension to packagist first for any extension that run with composer.

clarkwinkelmann

Cactus1805 you should be able to test locally without submitting the extension to Packagist if the workbench/packages folder is correctly configured.

If the package is submitted to Packagist but the workbench folder is not set up, the same command will install the master branch from the GitHub repository instead, which is sometimes desirable but usually not if you are working on the extension and want to test your changes before pushing the changes to GitHub.

Cactus1805

Thank you for your advice. As I don't have much experience in programming, I just tried to modify an existing extension and test it on the local site. When everything works as expected, I will create a repository on Github then submit it to Packagist for the production site to use. But I think this is not the correct method to develop an extension 😅

bachmx

I have successful installed a blank extension created by flarum cli. But when I enable that extension, access Forum frontent will show error "An error occurred while trying to load this page.". Any help?

clarkwinkelmann

bachmx try clearning the cache, and check for any error message in the browser console, in Flarum log file or in the webserver log file.