App Boilerplate

Changelog

Changelog

All notable changes to the Boilerplate App template are documented here.


[Unreleased]

Added

  • Documentation site integration with .flowstate/docs/ structure
  • Getting started guide for new developers
  • FAQ covering common questions
  • Troubleshooting guide for common issues
  • Workflow documentation for creating new apps

Changed

  • None

Fixed

  • None

[1.0.0] - 2025-01-22

Added

  • Initial release of the Boilerplate App template
  • Complete app structure with React Router v6 routing
  • FlowState Framework integration
    • FlowstateAppContainer for app context
    • FlowstateAppLayout for consistent layout
    • Shared Header and Sidebar components
  • Plugin architecture for host container integration
    • Plugin registration with AppPlugin interface
    • Lazy loading support via dynamic imports
    • Lifecycle hooks (onLoad, onUnload)
  • Dual-mode support
    • Standalone mode for development with mock services
    • Embedded mode for production in host container
  • Development tooling
    • Vite dev server with Hot Module Replacement
    • tsup build configuration with ESM and CJS outputs
    • TypeScript strict mode configuration
  • Styling
    • Tailwind CSS pre-configured
    • PostCSS and Autoprefixer setup
  • Example pages
    • HomePage with getting started content
    • Users, Orgs, and Workspaces pages for standalone mode
  • Configuration files
    • flowstate.json app manifest
    • package.json with proper exports
    • tsconfig.json with strict settings
    • vite.config.mts using shared configuration
    • tsup.config.ts for library builds

Technical Details

  • Package: @epicdm/flowstate-app-boilerplate
  • Base Path: /apps/boilerplate
  • Dev Port: 3210
  • Build Output: ESM, CJS, TypeScript declarations, CSS

Version Format

This changelog follows Keep a Changelog format.

  • Added for new features
  • Changed for changes in existing functionality
  • Deprecated for soon-to-be removed features
  • Removed for now removed features
  • Fixed for bug fixes
  • Security for vulnerability fixes

Template Updates

When updating the boilerplate template:

  1. Document all changes in this changelog
  2. Update version in package.json and flowstate.json
  3. Test both modes - standalone and embedded
  4. Update documentation if behavior changes
  5. Announce breaking changes to the team

Apps created from earlier versions are not automatically updated. Document migration steps for significant changes.


Migration Notes

From Pre-1.0 (if applicable)

If you created an app before the 1.0.0 release:

  1. Update framework imports:

    // Old
    import { AppContainer } from '@epicdm/flowstate-ui';
    
    // New
    import { FlowstateAppContainer } from '@epicdm/flowstate-app-framework';
    
  2. Update plugin structure to match the new AppPlugin interface

  3. Add flowstate.json manifest file if not present

  4. Update Vite config to use shared configuration:

    import { createViteConfig } from '@epicdm/flowstate-app-framework/config/vite';
    export default createViteConfig({ port: 3210 });
    
Previous
FAQ