You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://discord.gg/Pf9tdSjPeF)
7
7
8
-
💡 We are proud to announce that we were recently featured in a [LangChain](https://blog.langchain.dev/empowering-development-with-flowtestai/) blog post.\
9
-
🔓 Unlock use cases by understanding our motivation [dev.to](https://dev.to/flowtestai/launching-flowtestai-ide-for-api-first-workflows-integrations-and-automations-30hd)
8
+
💡 We are proud to announce that we were recently featured in a [LangChain](https://blog.langchain.dev/empowering-development-with-flowtestai/) blog post.
10
9
11
-
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.
12
-
13
-
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.
10
+
FlowTest is a powerful, code-agnostic tool designed to simplify the creation and execution of end-to-end API tests. With its intuitive interface and robust features, FlowTest empowers developers and QA teams to streamline their API testing process, improve collaboration, and gain valuable insights into their API performance.
14
11
15
12
<imgwidth="1728"alt="Screenshot 2024-04-18 at 5 41 43 PM"src="https://github.com/FlowTestAI/FlowTest/assets/5829490/c04f6e3e-fe69-4d25-a008-ba558c8fe149">
16
13
17
-
## CLI
14
+
## 🚀 Key Features
15
+
16
+
-**Low Code/No Code Solution**: Create complex end-to-end API tests without writing code.
17
+
-**Natural Language Processing**: Describe your test scenarios in plain English.
18
+
-**Support Leading LLMs**: Choose from a wide range of leading LLMs: OpenAI, AWS Bedrock, Google Gemini etc.
19
+
-**Drag-and-Drop Interface**: Visually design your API tests with ease.
20
+
-**OpenAPI Spec Integration**: Automatically parse and pre-fill request nodes from your OpenAPI specifications.
21
+
-**Cross-Platform Compatibility**: Available as an Desktop application for Mac, Windows, and Linux.
22
+
-**Local File System Integration**: Direct interaction with local file system for enhanced privacy and control.
23
+
-**Version Control Ready**: Easily collaborate using Git or any other VCS.
24
+
-**CI/CD Ready**: Run tests in CI pipelines with our CLI tool.
25
+
-**Advanced Analytics**: Gain insights into API performance and test results.
26
+
27
+
## 🛠️ Getting Started
28
+
29
+
### Desktop App Installation
30
+
31
+
1. Download FlowTestAI for your OS from our [releases page](https://github.com/FlowTestAI/FlowTest/releases).
32
+
2. Install and launch FlowTest like any other desktop application.
33
+
3. Start creating end-to-end API tests using natural language or drag-and-drop.
34
+
4. Save your work locally and use Git for version control, just like with traditional IDEs.
35
+
36
+
### CLI Installation (for CI/CD)
37
+
38
+
```bash
39
+
npm install -g flowtestai
40
+
```
41
+
18
42
https://www.npmjs.com/package/flowtestai
19
43
20
44
The CLI allows you to run flows created using FlowTestAI from command line interface making it easier to automate and run them in a CI/CD (continuous integration/development) fashion.
2. Go to Products -> Analytics -> Get Access Key Pairs
52
+
3. For CLI: Export key pairs as environment variables
53
+
4. For IDE: Open Settings and paste the access key pairs
54
+
5. Now start publishing scans for each test run.
55
+
56
+
## 📚 Documentation
25
57
26
58
https://flowtestai.gitbook.io/flowtestai
27
59
28
60
## Setup
29
61
30
-
## Production 🚀
62
+
## 💻 Production
31
63
32
64
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](https://github.com/FlowTestAI/FlowTest/releases), 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.
33
65
34
-
## Development 🔧
66
+
## 🔧 Development
35
67
36
68
### Prerequisite
37
69
@@ -103,7 +135,7 @@ This package uses version >= 18 of Node.js. There are different ways that you ca
103
135
104
136
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](https://pnpm.io/installation) and [corepack](https://github.com/nodejs/corepack) for troubleshooting. Pnpm installed with npm will overrun corepacks pnpm instance.
Fun fact: our contributing guide itself was an external contribution 🍺
114
146
115
-
## Support 🙋
147
+
## 🌟 Support
116
148
117
149
- ❓ QNA: feel free to ask questions, request new features or start a constructive discussion here [discussion](https://github.com/FlowTestAI/FlowTest/discussions)
118
150
- 🐛 Issues: Feel free to raise issues here [issues](https://github.com/FlowTestAI/FlowTest/issues) (contributing guidelines coming soon..)
119
151
- 🔄 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](https://flowtestai.gitbook.io/flowtestai) or email me at jsajal1993@gmail.com.
120
-
- 🔐 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](https://platform.openai.com/) or you can contact us on our [social media handles](https://flowtestai.gitbook.io/flowtestai) or at jsajal1993@gmail.com and we can provide you one.
152
+
- 🔐 Our tool integrates with various leading Large Lanugage Models (LLMs) if you wish to use the natural language to flow translation feature. You can request their api keys:
0 commit comments