wyatts97/user-stories

User Stories for Flarum

Maintainers

Package info

github.com/wyatts97/user-stories

Language:TypeScript

Type:flarum-extension

pkg:composer/wyatts97/user-stories

Statistics

Installs: 0

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

v1.0.2 2026-05-16 20:56 UTC

This package is auto-updated.

Last update: 2026-05-16 21:04:10 UTC


README

License

A modern, Instagram-style stories extension for Flarum. This is a fork of justoverclock/profile-stories rebuilt for Flarum 2.x with a completely redesigned user experience.

What's New

This fork transforms the original simple profile stories into a polished, Instagram-like stories system:

  • 24-hour expiring stories — Stories automatically expire after 24 hours and are hidden from the feed
  • Follow-based stories bar — Logged-in users see a horizontal scrollable bar of circle avatars from users they follow, displayed on the home/index page
  • Instagram-style gradient rings — Unseen stories get a colorful conic-gradient ring around the avatar (just like Instagram)
  • Full-screen story viewer — Tap left/right to navigate, segmented progress bars at the top, auto-advance timer, caption overlay
  • Polished create modal — Single-step story composer with live image preview, caption input, and optional link CTA
  • Removed global stories page — Stories are now follow-based instead of a global listing
  • Flarum 2.x compatible — Built on the new ApiResource architecture

Requirements

  • Flarum ^2.0
  • ianm/follow-users (optional) — Enables the follow-based stories bar. Without it, the stories bar will be empty but the extension will still function for profile stories.

    Note: ianm/follow-users currently requires Flarum ^1.8.3. A Flarum 2.x compatible version is needed for full follow-based functionality.

Installation

Install with composer:

composer require wyatts97/user-stories:"*"

Updating

composer update wyatts97/user-stories:"*"
php flarum migrate
php flarum cache:clear

Features

  • Create stories with images, captions, and optional link CTAs
  • Stories appear in a horizontal bar on the index page for logged-in users (when ianm/follow-users is installed)
  • Only shows stories from followed users (via ianm/follow-users)
  • Stories expire after 24 hours and are automatically filtered out
  • Profile stories page (/u/:username/stories) is still available
  • Notifications when someone creates a new story
  • Permission-based story creation, editing, and deletion

Credits

Links