Feedo

A modern, full-stack feedback management system with intelligent processing and real-time analytics

📋 Table of Contents

• About
• Features
• Tech Stack
• Getting Started
• Usage
• Project Structure
• Contributing
• License

🎯 About

Feedo is a comprehensive feedback management platform built with a modern, modular architecture. It combines a sleek React frontend, a robust Node.js backend, and an intelligent Python processing engine to deliver seamless feedback collection, analysis, and insights.

What makes Feedo special?

• 🚀 Modern, responsive UI built with React and Tailwind CSS
• ⚡ Real-time feedback processing and analysis
• 🧠 Intelligent data processing with Python
• 📊 Automated scoring and analytics
• 🔐 Secure and scalable architecture

✨ Features

User Experience

• Intuitive Interface - Clean, responsive design with shadcn/ui components
• Real-time Updates - Instant feedback submission and processing
• Rich Analytics - Visual dashboards and insights
• Multi-platform - Works seamlessly across devices

Technical Features

• RESTful API - Well-structured backend for data persistence
• Background Processing - Dedicated Python processor for heavy computations
• Type Safety - Full TypeScript support for robust development
• Hot Reloading - Fast development with Vite's HMR
• Modular Architecture - Clean separation of concerns

🛠️ Tech Stack

Frontend

• React - UI library for building interactive interfaces
• TypeScript - Type-safe JavaScript
• Vite - Next-generation frontend tooling
• Tailwind CSS - Utility-first CSS framework
• shadcn/ui - Accessible component library

Backend

• Node.js - JavaScript runtime
• Express.js - Web application framework
• RESTful API - Standard API architecture

Processor

• Python - High-level programming language
• Background Tasks - Asynchronous data processing
• Analytics Engine - Scoring, analysis, and cleanup operations

🚀 Getting Started

Prerequisites

Make sure you have the following installed:

• Node.js (v18.0.0 or higher)
• Python (v3.8.0 or higher)
• npm or Bun

Installation

1. Clone the repository

   git clone https://github.com/Shark-Bot-X/Feedo.git
   cd Feedo

2. Configure environment variables

   Create a .env file in the project root:

   # Add your environment variables here
   # Example:
   # DATABASE_URL=your_database_url
   # API_KEY=your_api_key
   # PORT=3000

3. Install dependencies

   Frontend (root directory):

   npm install
   # or
   bun install

   Backend:

   cd backend
   npm install
   # or
   bun install
   cd ..

   Python Processor:

   # Recommended: Create a virtual environment
   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate
   
   # Install dependencies
   pip install -r requirements.txt

💻 Usage

To run the complete Feedo application, you need to start all three services. Open three separate terminal windows and run:

Terminal 1: Frontend Development Server

npm run dev

The frontend will be available at http://localhost:5173 with hot-reloading enabled.

Terminal 2: Backend API Server

cd backend
node server.js

Note: If your entry file is different (e.g., index.js), adjust the command accordingly.

The API server will start on the configured port (default: http://localhost:3000).

Terminal 3: Feedback Processor

# Activate virtual environment if you created one
source venv/bin/activate  # On Windows: venv\Scripts\activate

python feedback_processor.py

This runs the Python script for background processing, scoring, and analysis tasks.

Available Scripts

npm run dev       # Start frontend development server
npm run build     # Build frontend for production
npm run preview   # Preview production build
npm run lint      # Run linter

📁 Project Structure

Feedo/
├── src/                      # Frontend source code
│   ├── components/           # React components
│   ├── pages/               # Application pages
│   ├── hooks/               # Custom React hooks
│   ├── lib/                 # Utility functions
│   └── App.tsx              # Root component
├── backend/                 # Backend source code
│   ├── routes/              # API routes
│   ├── controllers/         # Route controllers
│   ├── models/              # Data models
│   ├── middleware/          # Custom middleware
│   └── server.js            # Entry point
├── public/                  # Static assets
├── feedback_processor.py    # Python processing script
├── requirements.txt         # Python dependencies
├── package.json            # Node.js dependencies & scripts
├── vite.config.ts          # Vite configuration
├── tailwind.config.js      # Tailwind CSS configuration
├── tsconfig.json           # TypeScript configuration
└── README.md               # This file

🤝 Contributing

Contributions are welcome! Whether it's bug reports, feature requests, or code contributions, we appreciate your help in making Feedo better.

How to Contribute

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

Guidelines

• Follow the existing code style and conventions
• Write clear, descriptive commit messages
• Add tests for new features when applicable
• Update documentation as needed
• Ensure all tests pass before submitting

🐛 Issues

Found a bug or have a feature request? Please open an issue with:

• A clear and descriptive title
• Steps to reproduce (for bugs)
• Expected vs actual behavior
• Screenshots if applicable

📄 License

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

---

Made with ❤️ by Sharky

Report Bug · Request Feature