https://github.com/evernote/aquaman

https://github.com/evernote/aquaman

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/evernote/aquaman
• Owner: Evernote
• License: mit
• Created: 2019-05-03T17:33:07.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-06-02T14:44:11.000Z (over 1 year ago)
• Last Synced: 2024-09-21T21:39:16.746Z (4 months ago)
• Language: TypeScript
• Homepage: https://evernote-1.gitbook.io/aquaman/
• Size: 450 KB
• Stars: 18
• Watchers: 29
• Forks: 11
• Open Issues: 0
• Metadata Files:
  • Readme: README.MD
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Aquaman

Aquaman allows you to build composable, declarative flows with Redux.

[See full documentation.](https://evernote-1.gitbook.io/aquaman/)

## What is Aquaman for?

Aquaman can be helpful if you need to guide users through a series of steps through an application. At Evernote, we use Aquaman to onboard new users by stepping through a series on educational modals and tooltips.

Flows in Aquaman are built from arrays, where each item in the array represents a single step in the flow. Each step can be a Redux action (eg. show a modal or tooltip), a sub-series of actions (eg. show a tooltip, create a record, and fire a GA event -- all at once), or branch into a sub-flow based on user input.

## Why use Aquaman?

Aquaman allows you to build components that know nothing about where in a flow they are, or what comes next. It just knows that they're in a flow. That means when you're constructing your flow, it's very clear what is going to happen in each step, and you can easily rearrange, remove, or reuse steps without breaking anything.