Skip to content

Unknownmaster0/feedback-flow

Repository files navigation

๐Ÿš€ FeedbackFlow

A modern feedback collection platform for developers, students, and professionals

Live Demo GitHub


๐Ÿ“‹ Table of Contents


๐ŸŽฏ Overview

FeedbackFlow is a comprehensive feedback collection platform designed to bridge the gap between feedback providers and recipients. Built with modern web technologies, it enables seamless anonymous feedback collection, AI-powered suggestions, and easy integration into personal portfolios and professional websites.

๐ŸŽญ The Problem

  • Students and developers lack simple tools to collect user feedback on their projects
  • Existing feedback solutions are either too complex or too basic
  • No easy way to showcase received feedback on personal websites

๐Ÿ’ก The Solution

FeedbackFlow provides a personalized feedback collection system with:

  • One-click setup - Get your unique feedback URL instantly
  • AI-powered assistance - Smart suggestions help users write better feedback
  • Seamless integration - Embeddable widgets for any website
  • Export capabilities - Download and use your feedback data anywhere

โœจ Features

๐Ÿ”ฅ Core Features

  • ๐ŸŒ Public Profile URLs - Unique, shareable links for feedback collection
  • ๐Ÿค– AI-Powered Suggestions - Intelligent feedback prompts using Cohere AI
  • ๐Ÿ‘ค Anonymous Collection - Optional anonymous feedback submission
  • ๐Ÿ“Š Export Functionality - Download feedback data in multiple formats
  • ๐ŸŽจ Embeddable Widgets - Showcase feedback on your website
  • ๐Ÿ” Secure Authentication - NextAuth.js powered user management

๐Ÿšง Coming Soon

  • ๐Ÿ“ˆ Analytics Dashboard - Track feedback trends and insights
  • ๐ŸŽฏ Feedback Categories - Organize feedback by type and purpose
  • ๐Ÿ‘ฅ Team Collaboration - Multi-user feedback management
  • ๐ŸŽจ Custom Branding - Personalize your feedback pages
  • ๐Ÿ“ฑ Mobile App - Native mobile experience
  • โšก Real-time Notifications - Instant feedback alerts

๐Ÿ› ๏ธ Tech Stack

Frontend

Next.js React TypeScript Tailwind CSS

Backend

MongoDB Mongoose NextAuth

UI/UX

Radix UI Lucide FontAwesome

AI & Integration

Cohere Vercel


๐Ÿš€ Quick Start

Prerequisites

Node.js >= 18.0.0
MongoDB (local or cloud)
Yarn or npm package manager

Installation

  1. Clone the repository

    git clone https://github.com/Unknownmaster0/feedback-flow.git
    cd feedback-flow
  2. Install dependencies

    yarn install
    # or
    npm install
  3. Environment Setup Create a .env.local file in the root directory:

    # Database
    MONGODB_URI=your_mongodb_connection_string
    
    # Authentication
    NEXTAUTH_URL=http://localhost:3000
    NEXTAUTH_SECRET=your_super_secret_key
    
    # AI Integration
    COHERE_API_KEY=your_cohere_api_key
    
    # Email (Optional)
    EMAIL_SERVER_USER=your_email@example.com
    EMAIL_SERVER_PASSWORD=your_email_password
    EMAIL_SERVER_HOST=smtp.gmail.com
    EMAIL_SERVER_PORT=587
    EMAIL_FROM=noreply@feedbackflow.com
  4. Start the development server

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

๐Ÿณ Docker Setup (Optional)

# Build and run with Docker
docker-compose up --build

# Or use the provided Dockerfile
docker build -t feedbackflow .
docker run -p 3000:3000 feedbackflow

๐Ÿ“ฑ Usage Guide

๐Ÿ”ฐ Getting Started

  1. Sign Up - Create your account using email or OAuth providers
  2. Get Your URL - Receive your unique feedback collection link
  3. Share Your Link - Add it to your portfolio, email signature, or social media
  4. Receive Feedback - Monitor incoming feedback in your dashboard

๐Ÿ’ฌ Sending Feedback

  1. Visit a Profile - Click on any public profile or use a shared link
  2. Write Feedback - Use the rich text editor or AI suggestions
  3. Choose Privacy - Send anonymously or with your name
  4. Submit - Your feedback is delivered instantly

๐ŸŽจ Embedding Widgets

<!-- Add to your website -->
<div id="feedbackflow-widget" data-user="your-username"></div>
<script src="https://feedback-app-pi-two.vercel.app/embed.js"></script>

๐Ÿ“Š Exporting Data

  • JSON Format - For developers and integrations
  • CSV Format - For spreadsheets and analysis
  • PDF Reports - For presentations and portfolios

๐ŸŽจ Screenshots

๐Ÿ  Homepage

Homepage

๐Ÿ“ Feedback Form

Feedback Form

๐Ÿ“Š Dashboard

Dashboard


๐Ÿ”ฎ Roadmap

๐ŸŽฏ Phase 1 (Current) - Core Platform

  • User authentication and profiles
  • Feedback collection and display
  • AI-powered suggestions
  • Basic export functionality
  • Responsive web design

๐Ÿš€ Phase 2 (Q2 2025) - Enhanced Features

  • Advanced analytics dashboard
  • Feedback categorization and tagging
  • Custom branding options
  • Team collaboration features
  • API for third-party integrations

๐ŸŒŸ Phase 3 (Q3 2025) - Scale & Mobile

  • Mobile application (React Native)
  • Enterprise features and pricing
  • Advanced AI insights and sentiment analysis
  • White-label solutions
  • International localization

๐Ÿ”„ Continuous Improvements

  • Performance optimizations
  • Security enhancements
  • User experience improvements
  • Feature requests from community

๐Ÿค Contributing

We welcome contributions from the community! Here's how you can help:

๐Ÿ› Bug Reports

Found a bug? Please create an issue with:

  • Clear description of the problem
  • Steps to reproduce
  • Expected vs actual behavior
  • Screenshots if applicable

๐Ÿ’ก Feature Requests

Have an idea? Open an issue with:

  • Detailed feature description
  • Use case and benefits
  • Mockups or examples (if available)

๐Ÿ”ง Development Setup

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

๐Ÿ“ Code Guidelines

  • Follow TypeScript best practices
  • Use ESLint and Prettier for code formatting
  • Write meaningful commit messages
  • Add documentation for new features
  • Ensure responsive design compatibility

๐Ÿ† Acknowledgments

  • Cohere AI - For powering our intelligent feedback suggestions
  • Vercel - For seamless deployment and hosting
  • Radix UI - For beautiful, accessible UI components
  • Next.js Team - For the amazing React framework
  • Open Source Community - For inspiration and support

๐Ÿ‘จโ€๐Ÿ’ป Author

Sagar Singh

BTech CSE Student | Full-Stack Developer | AI Enthusiast

LinkedIn GitHub Email

"Building solutions that bridge the gap between feedback and growth"


๐Ÿ“„ License

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

MIT License

Copyright (c) 2025 Sagar Singh

โญ Star this repo if you find it helpful!

๐Ÿ”— Live Demo | Documentation | Report Bug

Made with โค๏ธ by Sagar Singh

Releases

No releases published

Packages

No packages published

Languages