Skip to content

feat: Showcase Project for ngx-statewise #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
1 of 5 tasks
Pierre-MarieMarchio opened this issue May 6, 2025 · 0 comments
Open
1 of 5 tasks

feat: Showcase Project for ngx-statewise #6

Pierre-MarieMarchio opened this issue May 6, 2025 · 0 comments
Assignees
Labels
feature New feature or request

Comments

@Pierre-MarieMarchio
Copy link
Owner

Pierre-MarieMarchio commented May 6, 2025

Description:

Create a comprehensive showcase project within our monorepo that demonstrates the capabilities, patterns, and best practices for using ngx-statewise. This showcase will serve as living documentation for developers adopting our lightweight state management library, providing real-world examples of action flows, state management, effects handling, and integration with Angular components. While this project won't be published to npm, it will be a crucial resource for understanding and adopting ngx-statewise effectively.


Tasks:

  • Setup Project Structure

    • Create a new Angular application within the monorepo structure
    • Configure build and test settings specific to the showcase needs
    • Add required dependencies including ngx-statewise
  • Implement Core Demo Features

    • Create a user authentication flow showcasing login/logout with proper state management
    • Implement a data management module demonstrating CRUD operations with API integration
    • Develop example showing cascading effects and complex state transitions
  • Demonstrate Key Concepts

    • Implement examples of States using both signals and regular properties
    • Create Action Groups and Single Actions with various payload types
    • Build Updators with both direct string keys and ofType pattern
    • Create Effects with both Promise and Observable return types
    • Create Managers that expose state via computed signals
  • Implementation Patterns Showcase

    • Demonstrate global vs local Updator registration
    • Show synchronous vs asynchronous dispatch patterns
    • Showcase cascading effects with chains of actions
    • Illustrate error handling and recovery patterns
  • UI and Documentation

    • Create a clean, intuitive UI that clearly demonstrates state changes
    • Add in-app documentation explaining key concepts alongside the examples
    • Include code snippets/explanations of what's happening "behind the scenes"
    • Add a dashboard showing real-time state visualization

Expected Outcome:

  • A fully functional Angular application that showcases all the core features of ngx-statewise in action
  • Clear examples of how to structure a real-world application using the library's patterns
  • Interactive demonstrations that make it easy for developers to understand the unidirectional flow
  • Documentation embedded in the application that explains key concepts alongside working examples
  • A reference implementation that developers can use to understand best practices when implementing ngx-statewise in their own projects
@Pierre-MarieMarchio Pierre-MarieMarchio self-assigned this May 6, 2025
@Pierre-MarieMarchio Pierre-MarieMarchio added the feature New feature or request label May 6, 2025
@Pierre-MarieMarchio Pierre-MarieMarchio moved this from Backlog to In progress in @ngx-statewise May 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
Status: In progress
Development

When branches are created from issues, their pull requests are automatically linked.

1 participant