Skip to content

Commit

Permalink
Refactor UI styles for content medium selection and prompt types
Browse files Browse the repository at this point in the history
  • Loading branch information
TMHSDigital committed Dec 23, 2024
1 parent 5ccf300 commit 876efdc
Show file tree
Hide file tree
Showing 2 changed files with 81 additions and 15 deletions.
29 changes: 19 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@ Transform your AI prompts with best practices and smart enhancements.
## Features

- 🚀 **Smart Prompt Enhancement**
- Automatically improve prompts based on type
- Support for completion, chat, and image prompts
- Content medium selection (Text/Image)
- Type-specific enhancements
- Real-time processing and feedback
- Comprehensive improvement suggestions

- 🎨 **Beautiful Interface**
- Intuitive medium and type selection
- Dark/Light mode with system preference detection
- Responsive design for all devices
- Clean, modern UI with smooth animations
Expand All @@ -18,11 +20,15 @@ Transform your AI prompts with best practices and smart enhancements.
- Save your favorite prompts
- View and manage prompt history
- Quick load of previous prompts
- Categorized prompt organization

- 🔗 **Easy Sharing**
- Share enhanced prompts across platforms
- Generate shareable links
- Multiple sharing options (social, messaging, email)
- Multiple sharing options:
- Social media (LinkedIn, Instagram)
- Messaging apps (WhatsApp, Telegram)
- Email and direct links
- QR code generation

## Preview

Expand All @@ -35,10 +41,11 @@ Transform your AI prompts with best practices and smart enhancements.
## Getting Started

1. Visit [Prompt Engine](https://your-username.github.io/prompt-engine)
2. Enter your prompt in the input area
3. Select the prompt type
4. Click "Enhance Prompt" to see the improved version
5. Use the share, copy, or save buttons to manage your prompt
2. Select your content medium (Text/Image)
3. Choose the appropriate prompt type
4. Enter your prompt in the input area
5. Click "Enhance Prompt" to see the improved version
6. Use the share, copy, or save buttons to manage your prompt

## Local Development

Expand Down Expand Up @@ -77,7 +84,8 @@ prompt-engine/
│ ├── bestPractices.js
│ ├── promptEnhancer.js
│ └── main.js
└── index.html
├── index.html
└── footer.html
```

## Contributing
Expand All @@ -96,4 +104,5 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file

- Thanks to all contributors who have helped shape this project
- Inspired by best practices in prompt engineering
- Built with modern web technologies
- Built with modern web technologies
- Created by TMHS Digital
67 changes: 62 additions & 5 deletions project-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,33 +20,41 @@ The project follows a modular architecture with clear separation of concerns:
- `main.js`: Main application logic and UI interactions
- `index.html`: Main application interface
- `styles.css`: Application styling
- `footer.html`: Footer component with branding and social links

## Features

1. **Prompt Enhancement**
- Smart prompt improvement based on type
- Medium-based categorization (Text/Image)
- Type-specific enhancements
- Real-time processing
- Multiple prompt types support
- Comprehensive improvement suggestions
- Best practices implementation

2. **User Interface**
- Intuitive medium and type selection
- Dark/Light mode with system preference detection
- Character counter with limits
- Loading states for better UX
- Responsive notifications
- Mobile-friendly design
- Smooth animations and transitions

3. **Sharing Capabilities**
- Multiple sharing platforms
- Social media integration (LinkedIn, Instagram)
- Messaging platforms (WhatsApp, Telegram)
- Email sharing
- Direct link copying
- QR code generation
- Native share API support
- Clipboard fallback
- QR code generation
- Direct links

4. **Prompt Management**
- Save prompts locally
- View saved prompt history
- Delete saved prompts
- Load previous prompts
- Categorized organization

## Technical Details

Expand All @@ -56,3 +64,52 @@ The project follows a modular architecture with clear separation of concerns:
- Modular design for easy maintenance
- Responsive CSS with Flexbox/Grid
- Progressive enhancement approach
- Semantic HTML structure
- Accessibility features
- Cross-browser compatibility

## Best Practices

1. **Code Organization**
- Modular file structure
- Clear separation of concerns
- Consistent naming conventions
- Comprehensive error handling

2. **Performance**
- Minimal DOM manipulation
- Efficient event handling
- Optimized animations
- Lazy loading where appropriate

3. **Accessibility**
- ARIA labels and roles
- Keyboard navigation
- Screen reader support
- Color contrast compliance

4. **User Experience**
- Intuitive navigation
- Clear feedback
- Responsive design
- Progressive enhancement

## Future Enhancements

1. **Features**
- User authentication
- Cloud storage integration
- Advanced prompt analytics
- AI-powered suggestions

2. **Technical**
- Service worker implementation
- PWA capabilities
- Enhanced offline support
- Performance optimizations

3. **Integration**
- API integrations
- Export/Import functionality
- Third-party platform connections
- Advanced sharing options

0 comments on commit 876efdc

Please sign in to comment.