flowmint

# 🌿 flowmint

**Flowmint** is a lightweight Node.js library for designing, managing, and optimizing user experience (UX) flows in modern web applications. Whether you're building onboarding journeys, navigation paths, or interaction checkpoints, Flowmint helps you structure and refine UX logic with clarity.

---

## 🚀 Features

- 📌 Define UX flow steps and transitions
- 🧠 Logic-based flow branching
- 🕹️ Middleware-style flow controllers
- 🧪 A/B variation support
- ✅ TypeScript support out of the box

---

## 📦 Installation

```bash
npm install flowmint
# or
yarn add flowmint

🧩 Usage

import { createFlow, step } from 'flowmint';

const signupFlow = createFlow('signup')
  .addStep(step('welcome'))
  .addStep(step('collect-info'))
  .addStep(step('verify-email'))
  .addStep(step('complete'));

const current = signupFlow.next('welcome');
console.log(current); // -> 'collect-info'

You can also handle branching:

signupFlow.branch('collect-info', (user) => {
  return user.hasEmail ? 'verify-email' : 'collect-email';
});

🔧 API

createFlow(name: string)

Creates a new UX flow controller.

.addStep(stepName: string)

Adds a step to the flow.

.branch(stepName: string, decisionFn: (context) => string)

Adds a decision-based branch to the flow.

.next(currentStep: string, context?: object)

Returns the next step based on the current one.

🎯 Use Cases

• Onboarding flows
• Interactive tutorials
• Product tours
• Form step progression
• Contextual UI paths

📁 Project Structure

flowmint/
├── src/
│   ├── index.ts
│   ├── flow.ts
│   └── utils.ts
├── test/
├── README.md
└── package.json

✅ Roadmap

• Flow visualization CLI
• Persistent user flow state
• React/Vue adapters
• Analytics plugin

🧪 Testing

npm test

🛡️ License

MIT © 2025