Download the PHP package ernestdefoe/flarum-showcase without Composer
On this page you can find all versions of the php package ernestdefoe/flarum-showcase. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ernestdefoe/flarum-showcase
More information about ernestdefoe/flarum-showcase
Files in ernestdefoe/flarum-showcase
Package flarum-showcase
Short Description Promote Extensions/Themes-tagged discussions to feature cards above the forum index.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package flarum-showcase
Flarum Showcase
A tag-driven feature rail for the Flarum 2 forum index. Pick a set of primary tags and a set of secondary tags in the admin panel — any discussion that carries one from each appears as a card above the discussion list, with the cover image pulled from the linked GitHub repository's social-preview when the opening post embeds a gh-readme shortcode.
What it does
Designed for support sites where each thread is "about" a specific extension or theme:
- Primary tag = the specific extension/theme slug (e.g.
theme-toggle,gh-readme,respawn). - Secondary tag = the umbrella category (e.g.
Extensions,Themes).
A discussion shows up in the showcase rail iff it carries at least one whitelisted primary tag AND at least one whitelisted secondary tag. Empty whitelist on either side ⇒ nothing qualifies (admin must explicitly opt in).
Features
- Two layout styles. Carousel (horizontal snap-scroll with prev/next buttons) or grid (wraps to multiple rows). Toggle in the admin panel.
- Automatic cover images. When the opening post contains a
[gh-readme repo="owner/name"]shortcode (fromernestdefoe/gh-readme), the card pulls the repo's GitHub social-preview as the cover. No manual image uploads. - Hashed-gradient fallback. Discussions without a
gh-readmeshortcode get a stable, deterministic gradient + first-letter monogram — so every card looks intentional even before authors update their posts. - Real tag pickers in the admin. Uses Flarum 2's bundled
TagSelectionModalvia theflarum-tags.select-tagssetting type. Each picker is filtered to either primary or secondary tags so admins can't pick the wrong kind. - Localized. Every visible string flows through
app.translator.trans(...)and lives inlocale/en.yml— drop in additional locale files (or usefof/linguist) to translate. - Strictly typed. TypeScript end-to-end, type-checked against Flarum core's
.d.tsandflarum/tags's.d.ts.
Compatibility
- Flarum core
^2.0 - PHP
^8.3 - Requires
flarum/tags - Pairs nicely with — but does not require —
ernestdefoe/gh-readme. Without it the synthesized gradient fallback is used for every card.
Install
Then enable Showcase from the admin panel's Extensions page.
Configure
Admin → Extensions → Showcase exposes:
| Setting | What it does |
|---|---|
| Display style | Carousel (default) or Grid. |
| Qualifying primary tags | Multi-select tag picker, restricted to primary tags. A discussion needs one of these to qualify. |
| Qualifying secondary tags | Multi-select tag picker, restricted to secondary tags. A discussion needs one of these too (AND, not OR). |
| Maximum cards | Hard cap on how many cards render (default 12). |
| Sort order | Latest activity, most replied, or pinned first then latest. |
Cover image resolution
For each qualifying discussion, the backend reads the opening post's raw content and runs a regex looking for [gh-readme repo="owner/name"]. If found, the cover URL is set to https://opengraph.githubassets.com/1/owner/name — the same image GitHub serves as the repo's social preview. Otherwise the frontend renders the hashed-gradient fallback.
This means ernestdefoe/gh-readme does not have to be installed locally for showcase to function — Showcase only parses the shortcode string, never invokes any gh-readme PHP. But you'll want gh-readme installed if you want the shortcodes to actually render as live READMEs inside the discussions.
Development
The TypeScript path mapping in js/tsconfig.json resolves flarum/* from ../vendor/flarum/core/js/dist-typings/ and flarum/tags/* from ../vendor/flarum/tags/js/dist-typings/. Run composer install at the repo root first.
Project layout
License
MIT
