Skip to content

Commit fe96bc2

Browse files
bajaputihbajaputih
committed
Commit
1 parent 1045e56 commit fe96bc2

File tree

1 file changed

+84
-111
lines changed

1 file changed

+84
-111
lines changed

‎README.md‎

Lines changed: 84 additions & 111 deletions
Original file line numberDiff line numberDiff line change
@@ -1,147 +1,120 @@
1-
# Visual Prompt Craft 🧠✨
1+
# Visual-Prompt-Craft 🖌️✨
22

3-
![GitHub stars](https://img.shields.io/github/stars/hamodywe/Visual-Prompt-Craft?style=social)
4-
![GitHub forks](https://img.shields.io/github/forks/hamodywe/Visual-Prompt-Craft?style=social)
5-
![GitHub license](https://img.shields.io/github/license/hamodywe/Visual-Prompt-Craft)
6-
[![Twitter Follow](https://img.shields.io/twitter/follow/hamodywe?style=social)](https://twitter.com/hamodywe)
3+
![Visual-Prompt-Craft](https://img.shields.io/badge/Visual--Prompt--Craft-v1.0.0-blue)
74

5+
Welcome to **Visual-Prompt-Craft**! This toolkit simplifies visual prompting using CLIP and ViT. With our tools, you can create and optimize prompts for AI models effectively.
86

9-
> Design. Iterate. Perfect. A powerful visual tool for crafting AI prompts.
7+
## Table of Contents
108

9+
- [Introduction](#introduction)
10+
- [Features](#features)
11+
- [Installation](#installation)
12+
- [Usage](#usage)
13+
- [Examples](#examples)
14+
- [Contributing](#contributing)
15+
- [License](#license)
16+
- [Contact](#contact)
1117

12-
<p align="center">
13-
<img src="https://raw.githubusercontent.com/hamodywe/Visual-Prompt-Craft/main/generated-icon.png" alt="Visual Prompt Craft Logo" width="200">
14-
</p>
18+
## Introduction
1519

16-
## 📌 Overview
20+
Visual-Prompt-Craft is designed for developers and researchers interested in AI prompt engineering. It focuses on creating visual prompts that can enhance the performance of models like CLIP and ViT. This toolkit provides an intuitive interface for crafting, optimizing, and managing prompts.
1721

18-
**Visual Prompt Craft** is an intuitive, drag-and-drop interface for designing complex AI prompts through a visual workflow. Turn your ideas into powerful, structured AI interactions with ease.
22+
For the latest releases, visit our [Releases section](https://github.com/bajaputih/Visual-Prompt-Craft/releases).
1923

20-
Create sophisticated prompt chains by connecting different types of nodes, manage prompt parameters, and generate high-quality AI results without writing complex prompt templates manually.
24+
## Features
2125

22-
### 🚀 Demo
23-
![Studio photo](assets/2.png)
26+
- **Easy Prompt Crafting**: Quickly create prompts using a user-friendly interface.
27+
- **Visual Design**: Utilize visual elements to enhance your prompts.
28+
- **Optimization Tools**: Optimize prompts for better performance with AI models.
29+
- **Prompt Templates**: Access a library of templates to kickstart your projects.
30+
- **Prompt Chains**: Combine multiple prompts for complex workflows.
31+
- **Flow-Based Prompting**: Design workflows that integrate various AI tasks.
2432

25-
Try the live demo: [Visual Prompt Craft](https://visual-prompt-craft.vercel.app)
33+
## Installation
2634

27-
## ✨ Key Features
35+
To install Visual-Prompt-Craft, follow these steps:
2836

29-
- **Visual Prompt Design** - Drag-and-drop interface for designing prompts
30-
- **Node-Based Workflow** - Create complex prompt chains with different node types
31-
- **Template Library** - Ready-made prompt templates for various use cases
32-
- **Real-Time Preview** - See your prompt structure as you build
33-
- **Parameter Management** - Define and manage variables within your prompts
34-
- **Conditional Flows** - Create prompts with decision points and branches
35-
- **Export & Import** - Share your prompt designs with others
36-
- **AI Integration** - Direct OpenAI API integration for testing prompts
37-
- **Conversation Import** - Import and convert conversations from ChatGPT or Claude
38-
- **Enhanced Zoom Controls** - Zoom in/out and toggle grid for better visualization
37+
1. Clone the repository:
38+
```bash
39+
git clone https://github.com/bajaputih/Visual-Prompt-Craft.git
40+
```
41+
2. Navigate to the project directory:
42+
```bash
43+
cd Visual-Prompt-Craft
44+
```
45+
3. Install the required dependencies:
46+
```bash
47+
pip install -r requirements.txt
48+
```
3949

40-
## 🧩 Node Types
50+
For the latest release, you can download the necessary files from the [Releases section](https://github.com/bajaputih/Visual-Prompt-Craft/releases).
4151

42-
- **Input Nodes** - Define user inputs and context
43-
- **Process Nodes** - Transform and analyze information
44-
- **Filter Nodes** - Filter and route based on conditions
45-
- **Condition Nodes** - Create branches based on logical conditions
46-
- **Output Nodes** - Format and finalize AI responses
52+
## Usage
4753

48-
## 📚 Specialized Templates
54+
Using Visual-Prompt-Craft is straightforward. After installation, you can start the application with:
4955

50-
### Development Templates
51-
- **Code Review Assistant** - Helps with code review and suggestions
52-
- **API Design Helper** - Assists with designing robust RESTful APIs
53-
- **Debugging Assistant** - Helps analyze and fix code bugs
54-
- **Software Architecture Designer** - Designs software architecture for new projects
55-
56-
### Content Creation Templates
57-
- **Text Summarization** - Summarizes text content efficiently
58-
- **Content Creation** - Generate professional blog posts and articles
59-
- **Q&A Chain** - Answer questions based on provided context
60-
61-
### Analysis Templates
62-
- **Sentiment Analysis** - Analyze sentiment and emotions in text
63-
- **Idea Generation** - Generate creative ideas for various purposes
64-
65-
## 🛠️ Technologies Used
66-
67-
- **Frontend**: React, TypeScript, ReactFlow, Tailwind CSS, shadcn/ui
68-
- **Backend**: Express, Node.js
69-
- **State Management**: React Query, Custom Hooks
70-
- **Styling**: Tailwind CSS with custom theme
71-
- **AI Integration**: OpenAI API, Anthropic Claude API support
72-
73-
## 🚀 Getting Started
74-
75-
### Prerequisites
76-
77-
- Node.js (v16+)
78-
- npm or yarn
79-
80-
### Installation
81-
82-
1. Clone the repository
8356
```bash
84-
git clone https://github.com/hamodywe/Visual-Prompt-Craft.git
85-
cd Visual-Prompt-Craft
57+
python main.py
8658
```
8759

88-
2. Install dependencies
89-
```bash
90-
npm install
91-
# or
92-
yarn install
93-
```
60+
### Creating a Visual Prompt
9461

95-
3. Start the development server
96-
```bash
97-
npm run dev
98-
# or
99-
yarn dev
100-
```
62+
1. Open the application.
63+
2. Select "Create New Prompt."
64+
3. Use the drag-and-drop interface to add visual elements.
65+
4. Adjust settings as needed.
66+
5. Save your prompt.
10167

102-
4. Open your browser and visit `http://localhost:5000`
68+
### Optimizing a Prompt
10369

104-
## 📚 Documentation
70+
1. Load your existing prompt.
71+
2. Use the optimization tools to adjust parameters.
72+
3. Test the prompt with your AI model.
73+
4. Save the optimized version.
10574

106-
For detailed documentation, visit our [Wiki](https://github.com/hamodywe/Visual-Prompt-Craft/wiki) page.
75+
## Examples
10776

108-
### User Guides
109-
- [Getting Started Guide](https://github.com/hamodywe/Visual-Prompt-Craft/wiki/Getting-Started)
110-
- [Creating Your First Prompt](https://github.com/hamodywe/Visual-Prompt-Craft/wiki/First-Prompt)
111-
- [Advanced Techniques](https://github.com/hamodywe/Visual-Prompt-Craft/wiki/Advanced-Techniques)
77+
Here are a few examples of what you can create with Visual-Prompt-Craft:
11278

113-
### Developer Guides
114-
- [Architecture Overview](https://github.com/hamodywe/Visual-Prompt-Craft/wiki/Architecture)
115-
- [Contributing](https://github.com/hamodywe/Visual-Prompt-Craft/wiki/Contributing)
116-
- [Creating Custom Nodes](https://github.com/hamodywe/Visual-Prompt-Craft/wiki/Custom-Nodes)
79+
### Example 1: Simple Visual Prompt
11780

118-
## 🤝 Contributing
81+
- **Description**: A basic visual prompt for image classification.
82+
- **Elements Used**: Image, Text.
83+
- **Output**: A well-structured prompt that can classify images accurately.
11984

120-
Contributions are welcome! Please feel free to submit a Pull Request.
85+
### Example 2: Complex Prompt Chain
12186

122-
1. Fork the repository
123-
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
124-
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
125-
4. Push to the branch (`git push origin feature/amazing-feature`)
126-
5. Open a Pull Request
87+
- **Description**: A series of prompts for generating captions for images.
88+
- **Elements Used**: Multiple images, Text, and a flow-based structure.
89+
- **Output**: Captions generated for a set of images in a cohesive manner.
12790

128-
See the [Contributing Guide](https://github.com/hamodywe/Visual-Prompt-Craft/wiki/Contributing) for more information.
91+
## Contributing
12992

130-
## 📝 License
93+
We welcome contributions! If you want to contribute to Visual-Prompt-Craft, please follow these steps:
13194

132-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
95+
1. Fork the repository.
96+
2. Create a new branch:
97+
```bash
98+
git checkout -b feature/YourFeature
99+
```
100+
3. Make your changes and commit them:
101+
```bash
102+
git commit -m "Add your message"
103+
```
104+
4. Push to the branch:
105+
```bash
106+
git push origin feature/YourFeature
107+
```
108+
5. Create a pull request.
133109

134-
## 📞 Contact
110+
## License
135111

136-
- **GitHub**: [@hamodywe](https://github.com/hamodywe)
137-
- **Email**: ios9.apk@gmail.com
112+
Visual-Prompt-Craft is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
138113

139-
---
114+
## Contact
140115

141-
<p align="center">
142-
Made with ❤️ by <a href="https://github.com/hamodywe">hamodywe</a>
143-
</p>
116+
For questions or feedback, please reach out via GitHub issues or contact the maintainers directly.
117+
118+
---
144119

145-
<p align="center">
146-
<a href="https://github.com/hamodywe/Visual-Prompt-Craft/stargazers">⭐ Star us on GitHub</a>
147-
</p>
120+
Thank you for using Visual-Prompt-Craft! We hope it enhances your AI prompt engineering experience. For the latest updates, check our [Releases section](https://github.com/bajaputih/Visual-Prompt-Craft/releases).

0 commit comments

Comments
 (0)