Skip to content

karenwky/shakespearean-made-easy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

af737f9 Β· Jan 26, 2025

History

16 Commits
Jan 24, 2025
Jan 24, 2025
Jan 24, 2025
Jan 26, 2025
Jan 23, 2025
Jan 26, 2025
Jan 26, 2025
Jan 24, 2025
Jan 24, 2025
Jan 26, 2025

Repository files navigation

Shakespearean Made Easy 🎭

An AI-powered Shakespeare sonnet generator and translator that brings the Bard's poetic style into multiple languages.

🌟 Features

  • Generate Shakespearean-style sonnets on various themes
  • Translate sonnets into 20+ languages
  • Modern, responsive design
  • One-click copy functionality
  • Real-time generation and translation

πŸ–ΌοΈ Preview

live-demo.mp4

πŸš€ Live Demo

Visit the live application: Shakespearean Made Easy

πŸ› οΈ Technologies Used

  • Vite.js
  • GitHub Models (Azure AI)
  • HTML5/CSS3
  • JavaScript (ES6+)
  • Vercel
  • Font Awesome Icons

πŸ“‹ Available Themes

Art, Beauty, Desire, Friendship, Jealousy, Love, Loss, Mortality, Nature, Poetry, Time

🌍 Supported Languages

Arabic, Bengali, Chinese (Simplified), Chinese (Traditional), English, French, German, Hindi, Indonesian, Italian, Japanese, Korean, Marathi, Portuguese, Punjabi, Russian, Spanish, Tamil, Telugu, Urdu, Vietnamese

πŸ—οΈ Installation

  • Install Node.js:
    Install Node.js for your operating system. Verify the installation by running node -v and npm -v in your terminal.
    β€Ž
  • Clone the repository:
    git clone https://github.com/karenwky/shakespearean-made-easy.git
    
  • Navigate to the project directory:
    cd shakespearean-made-easy
    
  • Install dependencies:
    npm install
    
  • Create a .env file in the root directory and add your GitHub personal access token (PAT) or Azure production key:
    VITE_GITHUB_TOKEN=your_api_key
    
  • Start the development server:
    npm run dev
    

πŸš€ Building for Production

npm run build

The built files will be in the dist directory.

πŸ™Œ Improvements Wishlist

Contributions are welcomed! Here are some areas we'd love to see improved:

  • Error Handling
    • Error message shown in box value text, e.g., Too many requests, please try again later.
    • Re-enable "GO" button for running request again
  • Separate CSS file βœ… (PR#2)
  • Separate file to maintain theme and translation language selection list
  • Dropdowns for selecting foundation models
  • Reposition copy buttons to align horizontally with h2, in the upper right corner of the box class image
  • Auto regenerate GitHub personal access token

🀝 Contributing

  • Fork the repository
  • Create your feature branch (git checkout -b feature/AmazingFeature)
  • Commit your changes (git commit -m 'Add some AmazingFeature')
  • Push to the branch (git push origin feature/AmazingFeature)
  • Open a Pull Request

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ™ Acknowledgments

  • Shakespeare's timeless works for inspiration
  • GitHub Models for powering the sonnet generation and translation
  • Cursor for AI coding assistant

πŸ“± Responsive Design

The application is fully responsive and works on:

  • Desktop computers
  • Tablets
  • Mobile devices

Releases

No releases published

Packages

No packages published