FlowTestAI / FlowTest

GenAI powered OpenSource IDE for API first workflows

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

FlowTestAI

Release Notes Linkedin Twitter Follow Chat on Discord

πŸ’‘ We are proud to announce that we were recently featured in a LangChain blog post.
πŸ”“ Unlock use cases by understanding our motivation dev.to

FlowTestAI stands as the world’s first GenAI powered OpenSource Integrated Development Environment (IDE) specifically designed to craft, visualize, and manage API-first workflows. Characterized by its speed, lightweight architecture, and localalized operation, FlowTestAI safeguards privacy while facilitating the seamless integration of API driven workflows.

It works as a normal desktop app and interacts directly with your local file system as other IDE(s) like VSCode, Intellij etc. This not only safeguards privacy but helps one to collaborate with others via git or any version control system.

Screenshot 2024-04-18 at 5 41 43β€―PM

🚧 We are actively working on launching a CLI. The CLI allows you to run API first workflows created using FlowTestAI from command line interface making it easier to automate and run them in a CI/CD (continuous integration/development) fashion.

Documentation πŸ“

https://flowtestai.gitbook.io/flowtestai

Setup

Production πŸš€

FlowTestAI is an electron app that runs entirely in your local environment interacting with your local file system just like other IDE(s) out there like VSCode, Intellij etc. The platform-specific binaries are available for download from our GitHub releases. We currently offer binaries for macOS, with versions for Windows and Linux under development 🚧. If you require a binary for a specific platform, please let us know in the Discussions section. We will prioritize your request accordingly.

Development πŸ”§

Prerequisite

This package uses version >= 18 of Node.js. There are different ways that you can install Node.js, following are steps for Node Verson Manager or NVM. If you need steps for other methods than NVM then please check Official Node.js documentation. Here is a sample walkthrough installing version 18.

  1. Installs nvm (Node Version Manager)

    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
  2. Download and install Node.js

    nvm install 18
  3. Verifies the right Node.js version is in the environment

    node -v # should print `v18.20.2`
  4. Verifies the right NPM version is in the environment

    npm -v # should print `10.5.0`

Main setup

  1. Clone the repository

    git clone https://github.com/FlowTestAI/FlowTest.git
  2. Go into repository folder

    cd FlowTest
  3. This project uses pnpm. Use corepack to enable the required pnpm version:

    corepack enable pnpm

    or install with npm

    npm install -g pnpm@9.0.6
  4. Install all project dependencies:

    pnpm install
  5. Build and start the app:

    pnpm start

    The app should start as a normal desktop app

    NOTE: if you use npm and corepack to install pnpm you will have two instances of pnpm. Make sure the version you're using is the correct version for the repo. Check the pnpm docs and corepack for troubleshooting. Pnpm installed with npm will overrun corepacks pnpm instance.

Contribution 🀝

"Little drops of water make a mighty ocean"

No contribution is small even if it means fixing a spelling mistake. Follow our contributing guide below. https://github.com/FlowTestAI/FlowTest/blob/main/CONTRIBUTING.md

Fun fact: our contributing guide itself was an external contribution 🍺

Support πŸ™‹

  • ❓ QNA: feel free to ask questions, request new features or start a constructive discussion here discussion
  • πŸ› Issues: Feel free to raise issues here issues (contributing guidelines coming soon..)
  • πŸ”„ Integration: If you want to explore how you can use this tool in your day to day activities or integrate with your existing stack or in general want to chat, you can reach out to us at any of our social media handles or email me at jsajal1993@gmail.com.
  • πŸ” Our tool requires OpenAI key if you wish to use the natural language to flow translation feature. You can either get yours by signing up here or you can contact us on our social media handles or at jsajal1993@gmail.com and we can provide you one.

License πŸ“„

Source code in this repository is made available under the MIT License.

About

GenAI powered OpenSource IDE for API first workflows

License:MIT License


Languages

Language:JavaScript 98.8%Language:CSS 0.8%Language:HTML 0.4%