Skip to content

Commit ef38380

Browse files
committed
update readme
1 parent dcfb815 commit ef38380

File tree

3 files changed

+20
-29
lines changed

3 files changed

+20
-29
lines changed

README.md

Lines changed: 20 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,27 @@
1-
# FlowTest
1+
# FlowTestAI
22

33
[![Release Notes](https://img.shields.io/github/release/FlowTestAI/FlowTest)](https://github.com/FlowTestAI/FlowTest/releases)
44
[![Linkedin](https://img.shields.io/badge/LinkedIn-blue?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/company/flowtestai)
55
[![Twitter Follow](https://img.shields.io/twitter/follow/FlowTestAI?style=social)](https://twitter.com/FlowTestAI)
66
[![Chat on Discord](https://img.shields.io/badge/chat-Discord-7289DA?logo=discord)](https://discord.gg/Pf9tdSjPeF)
77

8-
Leverage GenAI to convert your customer's interactions with your product into runnable flows all via natural language and simple drag and drop. Generated flows not only test the functional correctness of your product but also the time it takes your customers to perform these actions together.
8+
FlowTestAI stands as the world’s first GenAI powered OpenSource Integrated Development Environment (IDE) specifically designed to craft, visualize, and manage API-driven workflows. Characterized by its speed, lightweight architecture, and local operation, FlowTestAI safeguards privacy while facilitating the seamless integration of API driven workflows.
99

10-
- Step 1: Import your openAPI spec and describe your prodcut flow in natural language to our AI.
11-
- Step 2: Add an evaluate node at the end via simple drag and drop to check the final output.
12-
- Step 3: Run the created flow for a success/falure and observe the generated logs and timing info.
13-
- Step 4: Save and Export these runnable chains in json format and share with others.
14-
- Step 5: Have a beer! 🍺
10+
🚧 We are actively working on launching a CLI. The CLI allows you to run API driven workflows created using FlowTestAI from command line interface making it easier to automate and run them in a CI/CD (continuous integration/development) fashion.
1511

16-
![alt text](public/flowtest_1.gif)
12+
## Documentation 📝
1713

18-
## 👨‍💻 Developers
14+
https://flowtestai.gitbook.io/flowtestai
1915

20-
FlowTest has 2 major components -
16+
💡 We are proud to announce that we were recently featured in a LangChain blog post. You can read the article here.
2117

22-
- `server`: Node backend to serve API requests
23-
- `src`: React frontend
18+
## Setup
2419

25-
### Prerequisite
20+
## Production 🚀
2621

27-
- Install npm
28-
```bash
29-
npm install -g npm
30-
```
31-
- NodeJS >= 18.0.0
22+
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.
3223

33-
### Setup
24+
## Development 🔧
3425

3526
1. Clone the repository
3627
```bash
@@ -40,26 +31,26 @@ FlowTest has 2 major components -
4031
```bash
4132
cd FlowTest
4233
```
43-
3. Install all dependencies of all modules:
34+
3. Clean any previously installed dependencies:
4435
```bash
45-
npm install
36+
npm run clean
4637
```
47-
4. Rename `.env.example` to `.env` and enter your cerdentials, for instance
38+
4. Install all dependencies of all modules:
4839
```bash
49-
OPENAI_API_KEY={API_KEY_VALUE}
50-
PORT=3500
51-
...
40+
npm install
5241
```
5342
5. Start the app:
5443
```bash
5544
npm start
5645
```
57-
You can now access the app on [http://localhost:3500](http://localhost:3500)
46+
The app should start as a normal desktop app
5847

59-
## 🙋 Support
48+
## Support 🙋
6049

61-
Feel free to ask any questions, raise problems, and request new features in [discussion](https://github.com/FlowTestAI/FlowTest/discussions)
50+
- ❓ QNA: feel free to ask questions, request new features or start a constructive discussion here [discussion](https://github.com/FlowTestAI/FlowTest/discussions)
51+
- 🐛 Issues: Feel free to raise issues here [issues](https://github.com/FlowTestAI/FlowTest/issues) (contributing guidelines coming soon..)
52+
- 🔄 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.
6253

63-
## 📄 License
54+
## License 📄
6455

6556
Source code in this repository is made available under the [MIT License](LICENSE.md).

public/flowtest.gif

-33.2 MB
Binary file not shown.

public/flowtest_1.gif

-37 MB
Binary file not shown.

0 commit comments

Comments
 (0)