|
| 1 | +# MongoFeed |
| 2 | + |
| 3 | +MongoFeed is a comprehensive platform for product feedback analysis and sentiment tracking. It leverages MongoDB for data storage and Amazon Bedrock for AI-powered sentiment analysis, providing valuable insights into customer feedback and product reviews. |
| 4 | + |
| 5 | +> ♥️ Inpired by a customer success story : [Syncly](https://www.mongodb.com/customers/syncly) |
| 6 | +
|
| 7 | +## Hosted Version |
| 8 | + |
| 9 | +https://mongo-feed.vercel.app |
| 10 | + |
| 11 | +## Features |
| 12 | + |
| 13 | +- File upload for product feedback analysis (JSON, HTML, images) |
| 14 | +- Chat paste functionality for direct input of customer interactions |
| 15 | +- Sentiment analysis using Amazon Bedrock AI |
| 16 | +- Real-time processing queue for feedback analysis |
| 17 | +- Interactive charts and visualizations: |
| 18 | + - Feedback trends over time |
| 19 | + - Sentiment distribution |
| 20 | + - Top issues identification |
| 21 | +- Agent performance tracking and sentiment analysis |
| 22 | + |
| 23 | +## Prerequisites |
| 24 | + |
| 25 | +Before you begin, ensure you have the following installed: |
| 26 | +- Node.js (v14 or later) |
| 27 | +- npm (v6 or later) |
| 28 | +- MongoDB (6.0+) |
| 29 | +- An AWS account with access to Amazon Bedrock and Claude 3.5 V2 model |
| 30 | + |
| 31 | +## Installation |
| 32 | + |
| 33 | +1. **Clone the repository:** |
| 34 | + ```bash |
| 35 | + git clone <repository-url> |
| 36 | + cd mongo-feed |
| 37 | + ``` |
| 38 | + |
| 39 | +2. **Install dependencies:** |
| 40 | + ```bash |
| 41 | + npm install |
| 42 | + ``` |
| 43 | + |
| 44 | +3. **Configure environment variables:** |
| 45 | + - Create a `.env.local` file in the root directory. |
| 46 | + - Add your MongoDB connection string and AWS Bedrock credentials. |
| 47 | + ```env |
| 48 | + MONGODB_URI=your_mongodb_connection_string |
| 49 | + AWS_REGION=your_aws_region |
| 50 | + AWS_ACCESS_KEY_ID=your_aws_access_key_id |
| 51 | + AWS_SECRET_ACCESS_KEY=your_aws_secret_access_key |
| 52 | + ``` |
| 53 | + **Note:** Ensure you have the necessary permissions for Amazon Bedrock and MongoDB. |
| 54 | +
|
| 55 | +## Development |
| 56 | +
|
| 57 | +1. **Run the development server:** |
| 58 | + ```bash |
| 59 | + npm run dev |
| 60 | + ``` |
| 61 | + Open [http://localhost:3000](http://localhost:3000) in your browser to view the application. |
| 62 | + |
| 63 | +## Building for Production |
| 64 | + |
| 65 | +1. **Build the application:** |
| 66 | + ```bash |
| 67 | + npm run build |
| 68 | + ``` |
| 69 | + |
| 70 | +2. **Start the production server:** |
| 71 | + ```bash |
| 72 | + npm run start |
| 73 | + ``` |
| 74 | + |
| 75 | +## Usage |
| 76 | + |
| 77 | +To use MongoFeed: |
| 78 | + |
| 79 | +1. **Access the application** in your browser at [http://localhost:3000](http://localhost:3000) after running the development or production server. |
| 80 | +2. **Upload Feedback Files or Paste Chat Interactions:** |
| 81 | + - Navigate to the feedback input section. |
| 82 | + - Choose to upload files (JSON, HTML, images) or paste text from chat interactions. |
| 83 | + - Follow the on-screen instructions to input your feedback data. |
| 84 | +3. **View Sentiment Analysis Results and Visualizations:** |
| 85 | + - Once the feedback is processed, navigate to the dashboard. |
| 86 | + - Explore interactive charts and visualizations to understand: |
| 87 | + - Feedback trends over time |
| 88 | + - Sentiment distribution across feedback |
| 89 | + - Top issues identified from the feedback |
| 90 | +4. **Navigate the Dashboard:** |
| 91 | + - Use the dashboard to access different features, such as: |
| 92 | + - Real-time processing queue monitoring. |
| 93 | + - Agent performance tracking and sentiment analysis (if applicable). |
| 94 | + - Detailed views of individual feedback entries and their sentiment analysis. |
| 95 | + |
| 96 | +## Configuration |
| 97 | + |
| 98 | +- **Environment Variables:** |
| 99 | + - `MONGODB_URI`: MongoDB connection string for your MongoDB database. |
| 100 | + - `AWS_REGION`: AWS region where your Bedrock service is configured. |
| 101 | + - `AWS_ACCESS_KEY_ID`: AWS access key ID for authentication. |
| 102 | + - `AWS_SECRET_ACCESS_KEY`: AWS secret access key for authentication. |
| 103 | + |
| 104 | +- **Other configurations:** |
| 105 | + - The application may have additional configurations that can be set in the `.env.local` file or through the application's settings panel. Refer to the application documentation for advanced configuration options. |
| 106 | + |
| 107 | +## Contributing |
| 108 | + |
| 109 | +If you'd like to contribute to MongoFeed, please follow these guidelines: |
| 110 | +1. Fork the repository. |
| 111 | +2. Create a branch for your feature or bug fix. |
| 112 | +3. Ensure your code adheres to the project's coding standards. |
| 113 | +4. Submit a pull request with a clear description of your changes. |
| 114 | + |
| 115 | +## License |
| 116 | + |
| 117 | +[Specify the project license, e.g., MIT License] |
0 commit comments