Skip to content

CathySong/SmartReview

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

15 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

QuickReview - AI-Powered Google Review Generator

A complete solution for businesses to collect authentic Google reviews through QR/NFC scanning, AI-generated review suggestions, and one-click submission.

πŸš€ Features

Core Features

  • QR Code & NFC Integration: Customers scan to instantly access review page
  • AI Review Generation: Natural, authentic reviews generated in seconds
  • One-Click Google Submission: Direct submission with pre-filled 5-star reviews
  • Multiple Review Options: Choose from AI-generated variations
  • Regulatory Compliance: Follows Google and FTC guidelines

Technical Features

  • Next.js 14: Modern React framework with App Router
  • TypeScript: Full type safety
  • Tailwind CSS: Utility-first styling
  • OpenAI Integration: GPT-powered review generation
  • Google APIs: Places API integration
  • Responsive Design: Works on all devices
  • Vercel Ready: One-click deployment

πŸ“‹ Prerequisites

  • Node.js 18+ and npm/yarn
  • OpenAI API key (for AI features)
  • Google API key (for Places integration)
  • Google Place ID (for your business)

πŸ› οΈ Installation

  1. Clone the repository

    git clone https://github.com/yourusername/google-review-generator.git
    cd google-review-generator
  2. Install dependencies

    npm install
    # or
    yarn install
  3. Configure environment variables

    cp .env.example .env.local

    Edit .env.local with your API keys:

    OPENAI_API_KEY=your_openai_api_key_here
    GOOGLE_API_KEY=your_google_api_key_here
    GOOGLE_PLACE_ID=your_google_place_id_here
  4. Run development server

    npm run dev
    # or
    yarn dev
  5. Open your browser Navigate to http://localhost:3000

πŸš€ Deployment

Vercel (Recommended)

  1. Push your code to GitHub
  2. Import project in Vercel
  3. Add environment variables
  4. Deploy!

Other Platforms

The app is compatible with any platform that supports Next.js:

  • Netlify
  • AWS Amplify
  • Railway
  • Docker

πŸ“± Usage Workflow

For Businesses

  1. Generate QR Codes: Create QR codes for your location
  2. Place QR Codes: Display at checkout, tables, or entrance
  3. Customers Scan: Customers scan with phone camera
  4. AI Generates Review: System suggests authentic review text
  5. One-Click Submit: Customer submits 5-star review to Google

For Customers

  1. Scan QR code with phone camera
  2. Choose from AI-generated review options
  3. Click "Submit Review" button
  4. Review opens in Google Maps (pre-filled with 5 stars)
  5. Edit if desired, then click "Post"

πŸ”§ Configuration

Business Settings

Edit lib/google-review.ts to configure:

  • Default business information
  • Google Place ID
  • Business type
  • Review categories

AI Settings

Edit lib/ai-generator.ts to configure:

  • Review length (default: 15-25 words)
  • Business type focus
  • Review categories
  • Fallback reviews

Styling

Edit tailwind.config.js to customize:

  • Color scheme
  • Fonts
  • Spacing
  • Animations

βš–οΈ Regulatory Compliance

This tool is designed to be fully compliant with:

Google Review Policies

  • βœ… No automated review submissions
  • βœ… No incentives for reviews
  • βœ… Authentic customer experiences only
  • βœ… Users can edit AI-generated content
  • βœ… Transparent about AI assistance

FTC Guidelines

  • βœ… Clear disclosure of AI assistance
  • βœ… No misleading or fake reviews
  • βœ… Genuine customer feedback
  • βœ… No paid or incentivized reviews

Data Privacy

  • βœ… No personal data collection
  • βœ… No tracking of individual users
  • βœ… All processing happens client-side
  • βœ… No database required

πŸ“Š Analytics Integration

Optional analytics can be added:

Google Analytics

Add your GA ID to .env.local:

GOOGLE_ANALYTICS_ID=your_ga_id_here

Custom Analytics

Edit app/layout.tsx to add your analytics script.

πŸ›‘οΈ Security

  • API keys are stored in environment variables
  • No sensitive data stored in client-side code
  • HTTPS required for production
  • Regular dependency updates
  • Security headers configured

🀝 Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Test thoroughly
  5. Submit a pull request

πŸ“„ License

MIT License - see LICENSE file for details.

πŸ†˜ Support

πŸ™ Acknowledgments

  • OpenAI for GPT API
  • Google for Maps and Places APIs
  • Next.js team for the amazing framework
  • Vercel for hosting platform

Disclaimer: This tool is designed to assist with review generation while maintaining compliance with all relevant policies. Users are responsible for ensuring their use complies with Google's review policies and local regulations.

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors