Skip to content

README.md

Latest commit

 

History

History
111 lines (80 loc) · 3.17 KB

README.md

File metadata and controls

111 lines (80 loc) · 3.17 KB
Raw

PulseKit

PulseKit Logo

Feedback Widget That Doesn't Suck

Embed a beautiful feedback widget on your site in 2 minutes. Screenshot annotations, real-time analytics, Slack alerts. Completely free.

License: MIT Next.js Tailwind CSS

Features

  • One script tag — works on any site, any framework
  • Screenshot annotations — users click on the page to leave feedback
  • Real-time dashboard — filters, votes, priority scores
  • Slack + email alerts — instant notifications
  • Spam protection — rate limiting, bot detection
  • Beautiful by default — dark mode, smooth animations

Quick Start

1. Clone and install

git clone https://github.com/KebiLab/pulsekit.git
cd pulsekit
npm install

2. Run locally

npm run dev

Open http://localhost:3000

3. Deploy

Deploy with Vercel

Widget Integration

Add this to your site's <head>:

<script src="https://your-domain.com/w.js" data-key="your-api-key"></script>

Tech Stack

Project Structure

pulsekit/
├── src/
│   ├── app/
│   │   ├── page.tsx          # Landing page
│   │   ├── dashboard/        # Feedback dashboard
│   │   ├── admin/            # Admin panel
│   │   └── api/
│   │       ├── auth/         # API key auth
│   │       ├── checkout/     # Payment checkout
│   │       └── webhook/      # Webhook handler
│   └── components/
│       ├── MaterialIcon.tsx  # Google Material Icons
│       ├── JsonLd.tsx        # SEO structured data
│       └── images/           # Product screenshots
├── marketing/                # Launch materials
├── public/                   # Static assets
└── package.json

Environment Variables

# Auth
ADMIN_API_KEY=your-admin-key

# LemonSqueezy (optional)
LEMON_SQUEEZY_API_KEY=your-key
LEMON_STORE_ID=your-store-id
NEXT_PUBLIC_LEMON_PRO_VARIANT=variant-id
NEXT_PUBLIC_LEMON_TEAM_VARIANT=variant-id

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Author

Alexandr Kebikov — GitHub

License

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