Merge pull request #14 from btkcodedev/staging

Main release: v1.0.10:

.eslintrc.cjs

@@ -2,17 +2,17 @@ module.exports = {
   root: true,
   env: { browser: true, es2020: true },
   extends: [
-    'eslint:recommended',
-    'plugin:@typescript-eslint/recommended',
-    'plugin:react-hooks/recommended',
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:react-hooks/recommended",
   ],
-  ignorePatterns: ['dist', '.eslintrc.cjs'],
-  parser: '@typescript-eslint/parser',
-  plugins: ['react-refresh'],
+  ignorePatterns: ["dist", ".eslintrc.cjs"],
+  parser: "@typescript-eslint/parser",
+  plugins: ["react-refresh"],
   rules: {
-    'react-refresh/only-export-components': [
-      'warn',
+    "react-refresh/only-export-components": [
+      "warn",
       { allowConstantExport: true },
     ],
   },
-}
+};

README.md

@@ -1,38 +1,59 @@
-# Analysr - Business Analytics Platform 📊
-
-<div align="center">
-  <img src="https://images.unsplash.com/photo-1557683316-973673baf926?auto=format&fit=crop&q=80" width="800" alt="Analysr Banner" />
-
-  <p align="center">
-    <strong>Transform your business with powerful analytics and data-driven insights</strong>
-  </p>
-</div>
+# Analysr - Review Analytics Platform 📊
+
+![image](https://github.com/user-attachments/assets/1b26013b-25e6-4b70-a725-8a42faa91336)
+
+<b>Transform your business with <code>Analysr</code></b>
+
+## ⚡ One Liner
+This is my submission for <code>Airbyte-Motherduck Hackathon - December 2024 - January 2025</code>
+
+For all you speedy folks out there, here’s the summary:
+
+- **1.0.0**  
+  - With your customer reviews in Motherduck, along with your chosen business stack and areas of interest, Analysr is ready to dish out some insightful analytics. To sweeten the deal, Groq is also integrated to help you navigate all your growth phases.
+  - Your analytics lineup features Aspect Analysis, a Word Sentiment Heatmap (for those feelings), Advanced Text Analysis, Groq Business Analytics, Keyphrase Analysis, and a handy Competitor Comparison.
+
+## 🏗️ Architecture
+![image](https://github.com/user-attachments/assets/0abe96f6-414a-42d2-aa0d-d0950a7da194)
+
+
+## 🚶Walkthrough
+
+1) To obtain customer review insights, sync your data to Motherduck with the schema: <code>{ "review_text": "string", "stars": "number" }</code> (More schemas will be supported soon). We recommend using Airbyte due to its extensive list of sources and seamless data movement. ![image](https://github.com/user-attachments/assets/415aece5-6594-4649-8d84-ec2fa1707988)
+![image](https://github.com/user-attachments/assets/00bf63f5-952f-491a-9ffd-0241d2e2bfd2)
+2) Visit the Analysr website at (growwithanalysr.web.app) and click on the "Get Started Now" button for onboarding.
+![image](https://github.com/user-attachments/assets/95da4b69-29bb-4c88-9433-19865bc72093)
+3) Select your business stack and substack; Groq and queries will use this information to fetch insights.
+![image](https://github.com/user-attachments/assets/160c95bb-bad3-4c27-b5af-7fe651f2313c)
+4) Input your Motherduck token and wait for the connection to be established (the time required will depend on your network bandwidth).
+![image](https://github.com/user-attachments/assets/18d35b48-37c4-4348-8ea2-8c501a14f00a)
+5) Select the database and table where your customer reviews or any related reviews exist, and set the data limit.
+![image](https://github.com/user-attachments/assets/e88e07d8-1861-4f12-9dc9-672b45776509)
+6) Input your Groq token (recommended) to obtain AI-based insights.
+![image](https://github.com/user-attachments/assets/19178890-f24b-4d1c-ad07-f343e06c79c6)
+7) Optionally provide your Airbyte bearer token (from the cloud.airbyte.com settings page) and connection ID (from the connections tab URL) to trigger a sync for updating your Motherduck table.
+![image](https://github.com/user-attachments/assets/042ee2bf-8ff1-4ba3-b32c-cd720e52fb8e)
+![image](https://github.com/user-attachments/assets/9f3ae847-28e2-4a93-b8a5-354b87835962)
+8) Finally, input your area of interest for insights, such as customer satisfaction, and click "Continue to Dashboard."![image](https://github.com/user-attachments/assets/3c938fa2-a862-4ba6-b06e-b67bb139e71f)
+9) Wait a few seconds until all queries are executed and visualized.
+![image](https://github.com/user-attachments/assets/cf22aa51-cdb2-4e3f-99d6-ef93bf8f8c45)
+10) Voilà! Your dashboard will be ready, featuring all Analysr's capabilities to support your next big step!
+![image](https://github.com/user-attachments/assets/1ae1427d-c315-4e02-ac75-158e3cb14d61)
+
+Need dataset and example method to test?
+1. Hugging face dataset URL which I used, https://huggingface.co/datasets/Yelp/yelp_review_full
+2. Import it to motherduck via airbyte (Set huggingface as source and motherduck as destination)
+3. Get Groq token at, https://console.groq.com/keys
+4. Click on continue to dashboard! That's it. Please try yourself, its fun!
 
 ## ✨ Features
 
-### 🎯 Smart Business Insights
-- AI-powered analysis of customer feedback and market trends
-- Sentiment analysis and emotion tracking
-- Key phrase extraction and topic modeling
-- Competitive benchmarking and industry comparisons
-
-### 📈 Advanced Analytics
-- Real-time data processing and visualization
-- Customizable dashboards and reports
-- Trend analysis and forecasting
-- Performance metrics and KPIs
-
-### 🔍 Deep Customer Understanding
-- Customer sentiment tracking
-- Demographic analysis
-- Behavior pattern recognition
-- Satisfaction metrics and NPS tracking
-
-### 🚀 Growth Opportunities
-- Market opportunity identification
-- Customer pain point analysis
-- Competitive advantage analysis
-- Strategic recommendations
+- **Aspect Analysis:** Gain insights into different aspects of customer feedback.
+- **Word Sentiment Heatmap:** Visualize sentiment trends in your reviews.
+- **Advanced Text Analysis:** Delve deeper into the nuances of customer language.
+- **Groq Business Analytics:** Access data-driven insights to inform your growth strategy.
+- **Keyphrase Analysis:** Identify and analyze key phrases that matter to your customers.
+- **Competitor Comparison:** Benchmark your performance against competitors.
 
 ## 🛠️ Technology Stack
 
@@ -42,39 +63,38 @@
 - **Visualization**: Recharts
 - **State Management**: Zustand
 - **Animations**: Framer Motion
+- **Hosting**: Firebase (Production), Vercel (Experiment)
+- **Proxy**: Supabase edge functions
+- **CI/CD**: GitHub Actions for automated deployment
+
+## Future roadmap
+
+- **Microservice for generating queries**: Currently all queries for analytics are highly coupled with code, seperation of concerns to microservice
+  - [x] Create mock express server and deployed as supabase functions
+  - [ ] Separate DuckDB queries for as an api call
+  - [ ] Enhance microservice with GPT Wrapper
+  - [ ] Enhance business insights from Groq: Currently it hallucinates as the mixtral model is not powerful (Requires funding) 
 
 ## 🚀 Getting Started
 
 1. Clone the repository:
+
 ```bash
-git clone https://github.com/yourusername/analysr.git
+git clone https://github.com/btkcodedev/airbyte-motherduck-hackathon.git
 ```
 
 2. Install dependencies:
+
 ```bash
 npm install
 ```
 
-3. Set up environment variables:
-```env
-MOTHERDUCK_TOKEN=your_token
-GROQ_API_KEY=your_key
-```
+3. Start the development server:
 
-4. Start the development server:
 ```bash
 npm run dev
 ```
 
-## 📊 Dashboard Features
-
-- **Real-time Analytics**: Monitor business performance in real-time
-- **Sentiment Analysis**: Track customer sentiment and emotions
-- **Competitive Analysis**: Compare performance against industry benchmarks
-- **Text Analysis**: Extract insights from customer feedback
-- **Trend Visualization**: Track metrics over time with interactive charts
-- **AI Insights**: Get AI-powered recommendations for business growth
-
 ## 🔒 Security
 
 - Secure token management
@@ -84,18 +104,18 @@ npm run dev
 
 ## 📄 License
 
-MIT License - feel free to use this project for your own purposes!
+MIT License - feel free to use this project for your purposes!
 
 ## 🤝 Contributing
 
 Contributions are welcome! Please feel free to submit a Pull Request.
 
 ## 📬 Contact
 
-For questions and support, please open an issue or contact us at [email protected]
+For questions and support, please open an issue or contact at [email protected]
 
 ---
 
 <div align="center">
-  <strong>Built with ❤️ for growing businesses</strong>
-</div>
+  <strong>Built with ❤️ for growing businesses by bktcodedev</strong>
+</div>

eslint.config.js

@@ -1,26 +1,26 @@
-import js from '@eslint/js';
-import globals from 'globals';
-import reactHooks from 'eslint-plugin-react-hooks';
-import reactRefresh from 'eslint-plugin-react-refresh';
-import tseslint from 'typescript-eslint';
+import js from "@eslint/js";
+import globals from "globals";
+import reactHooks from "eslint-plugin-react-hooks";
+import reactRefresh from "eslint-plugin-react-refresh";
+import tseslint from "typescript-eslint";
 
 export default tseslint.config(
-  { ignores: ['dist'] },
+  { ignores: ["dist"] },
   {
     extends: [js.configs.recommended, ...tseslint.configs.recommended],
-    files: ['**/*.{ts,tsx}'],
+    files: ["**/*.{ts,tsx}"],
     languageOptions: {
       ecmaVersion: 2020,
       globals: globals.browser,
     },
     plugins: {
-      'react-hooks': reactHooks,
-      'react-refresh': reactRefresh,
+      "react-hooks": reactHooks,
+      "react-refresh": reactRefresh,
     },
     rules: {
       ...reactHooks.configs.recommended.rules,
-      'react-refresh/only-export-components': [
-        'warn',
+      "react-refresh/only-export-components": [
+        "warn",
         { allowConstantExport: true },
       ],
     },

firebase.json

@@ -1,11 +1,7 @@
 {
   "hosting": {
     "public": "dist",
-    "ignore": [
-      "firebase.json",
-      "**/.*",
-      "**/node_modules/**"
-    ],
+    "ignore": ["firebase.json", "**/.*", "**/node_modules/**"],
     "rewrites": [
       {
         "source": "**",
@@ -28,4 +24,4 @@
       }
     ]
   }
-}
+}

index.html

@@ -6,8 +6,8 @@
     <meta http-equiv="Cross-Origin-Opener-Policy" content="same-origin" />
     <meta http-equiv="Cross-Origin-Embedder-Policy" content="require-corp" />
 
-    <title>Analysr - Business Analytics Platform</title>
-    <meta name="title" content="Analysr - Business Analytics Platform">
+    <title>Analysr</title>
+    <meta name="title" content="Analysr">
     <meta name="description" content="Transform your business with powerful analytics and data-driven insights. Make informed decisions that drive growth and customer satisfaction.">
 
     <meta property="og:type" content="website">