@legible-sync/example-console

Console-based example application demonstrating the LegibleSync framework.

Running the Example

From the root of the monorepo, run:

npm run dev:console

This will demonstrate:

• User registration with validation
• Synchronization rules execution
• Flow auditing and tracing
• State persistence

What It Does

The console example shows a complete user registration flow:

1. User Registration: Creates a new user account
2. Password Validation: Ensures password meets requirements
3. JWT Generation: Creates authentication tokens
4. State Persistence: Saves data using RDF/SPARQL patterns
5. Flow Auditing: Shows complete execution trace

Code Structure

src/
├── concepts/          # Business logic modules
│   ├── User.ts       # User management
│   ├── Password.ts   # Password handling
│   ├── JWT.ts        # Token generation
│   └── Persistence.ts # RDF storage
├── syncs/            # Synchronization rules
│   └── registration.sync.ts
├── utils/            # Utilities
│   └── audit.ts      # Flow auditing
└── index.ts          # Main application

Learning Points

• How to define and register concepts
• Creating synchronization rules
• Flow management and auditing
• State persistence patterns
• Error handling and validation

Related Packages

• @legible-sync/core - Framework core
• @legible-sync/example-express - REST API example

License

MIT License - Copyright (c) 2025 Mauro Stepanoski

Links

• GitHub Repository
• Framework Documentation