simonsan / superflows_ai_support

Open-source toolkit to build an AI assistant for SaaS products

Superflows

Superflows makes it easy to add an AI assistant to a software product. This lets users ask questions in natural language and the assistant makes API calls to answer them.

E.g. a CRM user could ask: "What's the status of the B Corp deal?". A product analytics tool user could ask: "What did users think of the UI change?".

You can try out the cloud version for free here or self-host (instructions below). You can learn more on our documentation pages.

Setup

Setup involves three steps:

1. Upload API specification
2. Test in the playground
3. Integrate into your product in a few lines of code

Features

• Developer dashboard to configure and test your product assistant
• Public API
• Answers in the same language the question is asked in
• UI components (find React components here)

Roadmap

Available on our documentation page.

Status

• Alpha: Not ready for use on production systems.
• Beta: Ready for use on production systems, but not yet considered stable.
• Stable: Ready for use on production systems.

Installation

npm i

Development

You need to be running a local version of Supabase to develop this project locally.

Here are comprehensive instructions on using the Supabase CLI

(note: if you have used Supabase in other projects before, you may have to supabase stop before running supabase start)

If using npm

npm install supabase --save-dev
npx supabase start

The 2nd command should give you an anon_api_key and a service_role key.

You'll need to enter these into the .env file. Check out .env.example for the format and variables required.

Once you fill in .env.example, rename it .env.

To run in development mode:

make run

(Alternatively, if you don't have make, use npm run dev)