Skip to content

NUVoize/wan22-brkn-prompt-helper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

49 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

WAN 2.2 - BRKN AI Prompt Generator

A powerful AI-powered prompt generation tool built with React, TypeScript, and Google's Gemini AI. Generate creative prompts for various content types including images, videos, JSON data, and more.

πŸš€ Features

  • Multi-format Prompt Generation: Create prompts for images, videos, clapperboard scenes, JSON data, and custom formats
  • Provider-agnostic LLM selection: Choose between Google Gemini, OpenAI, Anthropic, Stability AI, and Perplexity directly in the app
  • AI-Powered Suggestions: Intelligent prompt generation powered by your selected provider (Gemini by default)
  • Interactive UI: Modern, responsive interface built with Radix UI components
  • Real-time Generation: Fast and efficient prompt creation with loading states
  • Customizable Settings: Configurable AI parameters and preferences
  • Mobile Responsive: Optimized for all device sizes

πŸ› οΈ Tech Stack

  • Frontend: React 18, TypeScript, Vite
  • Styling: Tailwind CSS, Radix UI
  • LLM Integration: Provider-agnostic router (Gemini, OpenAI, Anthropic, Stability AI, Perplexity)
  • State Management: TanStack Query
  • Routing: React Router DOM
  • Icons: Lucide React
  • Build Tool: Vite
  • Package Manager: Bun

πŸ“‹ Prerequisites

  • Node.js (v18 or higher)
  • Bun package manager
  • An API key for at least one supported LLM provider (see links below)

πŸš€ Quick Start

Windows Users (Easy Install)

For Windows users, we provide convenient batch files for easy setup:

  1. Clone the repository

    git clone https://github.com/NUVoize/wan22-brkn-prompt-helper.git
    cd wan22-brkn-prompt-helper
  2. Run the Windows installer

    install-windows.bat

    This will:

    • Check prerequisites (Node.js, npm/Bun)
    • Install dependencies automatically
    • Offer to start the development server
    • Open the app in your browser
  3. Start the app later (optional)

    start-ui.bat

Manual Installation (All Platforms)

  1. Clone the repository

    git clone https://github.com/NUVoize/wan22-brkn-prompt-helper.git
    cd wan22-brkn-prompt-helper
  2. Install dependencies

    bun install
    # or
    npm install
  3. Start the development server

    bun run dev
    # or
    npm run dev
  4. Open your browser Navigate to http://localhost:8080

  5. Select provider and add your API key In the app, click the gear icon (Settings) β†’ choose your LLM provider β†’ paste your API key β†’ Save. Keys are stored securely in your browser's localStorage; no .env is required for normal use.

πŸ“ Project Structure

services/               # LLM provider services (root-level)
β”œβ”€β”€ llm/router.ts       # Provider-agnostic LLM router (select & store keys)
└── geminiService.ts    # Gemini AI integration

src/
β”œβ”€β”€ components/          # Reusable UI components
β”‚   β”œβ”€β”€ ui/              # Shadcn/UI components
β”‚   β”œβ”€β”€ icons/           # Custom icon components
β”‚   β”œβ”€β”€ Header.tsx       # App header
β”‚   β”œβ”€β”€ Footer.tsx       # App footer
β”‚   └── ...
β”œβ”€β”€ pages/               # Page components
β”‚   β”œβ”€β”€ Index.tsx        # Main page
β”‚   └── NotFound.tsx     # 404 page
β”œβ”€β”€ lib/                 # Utility functions
β”‚   └── utils.ts         # Common utilities
β”œβ”€β”€ hooks/               # Custom React hooks
└── styles/              # Global styles

πŸ”§ Configuration

LLM Providers & API Keys

This app supports multiple providers via the in-app Settings dialog:

How keys are stored

  • Open Settings (gear icon) β†’ choose a Provider β†’ paste your API key β†’ Save.
  • Keys are stored in localStorage under:
    • GEMINI_API_KEY
    • OPENAI_API_KEY
    • ANTHROPIC_API_KEY
    • STABILITY_API_KEY
    • PERPLEXITY_API_KEY
  • The active provider is stored under LLM_PROVIDER.

Note: Non-Gemini providers may currently fall back to Gemini until their direct integrations are enabled (see services/llm/router.ts).

🎨 Available Prompt Types

  • πŸ–ΌοΈ Image Prompts: Generate descriptive prompts for image creation
  • 🎬 Video Prompts: Create prompts for video content generation
  • 🎞️ Clapperboard: Generate film/video scene descriptions
  • πŸ“„ JSON Data: Create structured data prompts
  • πŸ’‘ Custom Ideas: General-purpose creative prompts

πŸš€ Build Commands

# Development server
bun run dev

# Production build
bun run build

# Development build
bun run build:dev

# Preview production build
bun run preview

# Lint code
bun run lint

🌐 Deployment

This project is configured for deployment on Vercel and other modern hosting platforms.

  1. Build the project

    bun run build
  2. Deploy to your preferred platform

    • Vercel: Connect your GitHub repository
    • Netlify: Upload the dist folder
    • Other platforms: Use the generated dist folder

πŸ”§ Development

Adding New Prompt Types

  1. Create an icon component in src/components/icons/
  2. Add the prompt type to the main interface
  3. Update the Gemini service to handle the new type
  4. Test the integration

Styling Guidelines

  • Use Tailwind CSS classes
  • Follow the existing design system
  • Ensure responsive design
  • Maintain accessibility standards

🀝 Contributing

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/new-feature
  3. Commit your changes: git commit -m 'Add new feature'
  4. Push to the branch: git push origin feature/new-feature
  5. Submit a pull request

πŸ›‘οΈ Usage Policy (Personal Use Only)

This software is provided for non-commercial use only. You may use, copy, and modify it solely for personal, educational, research, or internal evaluation purposes.

Prohibited uses include, without limitation:

  • Any form of commercial use, monetization, or profit-generating activity
  • Offering the software or its outputs as part of a paid product, service, SaaS, or API
  • Charging for access, hosting paid instances, reselling, sublicensing, or bundling in commercial offerings
  • Advertising-supported distribution or any use intended to derive revenue

Commercial licensing:

  • For any commercial use, you must obtain prior written permission and a commercial license from BRKN.TRIB.
  • Contact: [email protected] or via GitHub to request permission.

Compliance note: This policy is enforced by the project’s license.

πŸ“„ License

This project is licensed under the PolyForm Noncommercial License 1.0.0. Commercial use requires a separate license from BRKN.TRIB. See the LICENSE file for full terms.

πŸ†˜ Support

If you encounter any issues or have questions:

  1. Check the Issues page
  2. Create a new issue with detailed information
  3. Contact the development team

πŸ™ Acknowledgments


Made with ❀️ by the BRKN team