Skip to content

gruntcode/Friday-File-Sense

Repository files navigation

Friday File Sense

Friday File Sense

Your intelligent AI assistant for document analysis

License: MIT Node.js Version Powered by Groq


Friday File Sense uses Groq Cloud's Llama-3.1-8B-instant model to provide instant insights, summaries, and actionable recommendations from your files. Upload documents and get intelligent AI-powered analysis in seconds.

✨ Features

  • πŸ€– AI-Powered Analysis - Uses Groq's Llama-3.1-8B-instant model for intelligent file analysis
  • πŸ“„ Multi-Format Support - PDF, CSV, TXT, DOCX, XLSX file processing
  • 🎨 Modern UI - Responsive design with dark mode support
  • πŸ“Š Structured Results - Get summaries, insights, and actionable recommendations
  • πŸ”’ Secure - API key protection and file validation
  • ⚑ Fast Processing - Optimized for quick analysis and response
  • πŸ“₯ Export Options - Download results as PDF with one click
  • πŸŒ™ Dark Mode - Easy on the eyes with automatic theme switching

πŸ“ Supported File Types

Format Description Max Size
PDF Text extraction and document analysis 10MB
CSV Data analysis with insights and patterns 10MB
TXT Plain text content analysis 10MB
DOCX Microsoft Word document processing 10MB
XLSX Excel spreadsheet analysis 10MB

πŸš€ Quick Start

1. Get Groq API Key

  1. Visit Groq Cloud Console
  2. Sign up or log in to your account
  3. Navigate to API Keys section
  4. Create a new API key
  5. Copy the API key for use in step 4

2. Install Dependencies

npm install

3. Configure Environment

Edit the .env file and replace your_groq_api_key_here with your actual Groq API key:

GROQ_API_KEY=gsk_your_actual_api_key_here
PORT=3001
NODE_ENV=development

4. Start the Server

# Development mode with auto-reload
npm run dev

# Production mode
npm start

5. Access the Application

Open your browser and navigate to:

http://localhost:3001

πŸ“‘ API Endpoints

Health Check

GET /api/health

Returns server status and confirms API is running.

File Analysis

POST /api/analyze

Upload files for AI analysis. Supports multipart/form-data with files field.

Request: Multipart form data with files Response: JSON with analysis results for each file

πŸ’‘ Usage

  1. Upload Files: Drag and drop files or click to browse
  2. Analyze: Click "Analyze with Llama 3.1-8B" button
  3. Review Results: Get structured analysis with:
    • Comprehensive summaries
    • Key insights and patterns
    • Actionable recommendations
    • Potential issues or concerns

βš™οΈ Configuration

Environment Variables

Create a .env file in the root directory:

GROQ_API_KEY=your_groq_api_key_here
PORT=3001
NODE_ENV=development

File Limits

  • Maximum file size: 10MB per file
  • Maximum files per request: 10 files
  • Supported formats: PDF, CSV, TXT, DOCX, XLSX only

πŸ›‘οΈ Error Handling

The application provides detailed error messages for:

  • Missing API key configuration
  • Unsupported file formats
  • File size limits exceeded
  • Network connectivity issues
  • AI processing errors

πŸ”§ Development

Project Structure

FridayFileSense/
β”œβ”€β”€ index.html          # Frontend application
β”œβ”€β”€ server.js           # Backend Express server
β”œβ”€β”€ package.json        # Dependencies and scripts
β”œβ”€β”€ .env               # Environment variables
β”œβ”€β”€ .gitignore         # Git ignore rules
β”œβ”€β”€ README.md          # This file
└── uploads/           # Temporary file storage (auto-created)

Technologies Used

Frontend:

  • HTML5, CSS3, JavaScript (ES6+)
  • TailwindCSS for styling
  • Feather Icons for UI icons

Backend:

  • Node.js with Express.js
  • Groq SDK for AI integration
  • Multer for file uploads
  • Various parsers (pdf-parse, csv-parser, mammoth, xlsx)

πŸ› Troubleshooting

Common Issues

  1. "Cannot connect to server"

    • Ensure the server is running: npm start
    • Check the port (default: 3001)
  2. "Groq API key not configured"

    • Verify your .env file has the correct API key
    • Restart the server after updating .env
  3. "File too large"

    • Files must be under 10MB
    • Consider compressing large files
  4. "Unsupported file type"

    • Only PDF, CSV, TXT, DOCX, XLSX are supported
    • Check file extension is correct

Getting Help

If you encounter issues:

  1. Check the browser console for error messages
  2. Review server logs in the terminal
  3. Verify your Groq API key is valid and has credits
  4. Ensure all dependencies are installed correctly

πŸ“Έ Screenshots

Light Mode

Clean, modern interface with intuitive file upload and analysis.

Dark Mode

Easy on the eyes with full dark mode support.

🀝 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/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

πŸ“„ License

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

πŸ™ Acknowledgments

πŸ“§ Contact

Tony Ramirez - @gruntcode - tony.ramirez@gruntcode.com

For questions or support, please open an issue.


Friday File Sense - Your AI Document Assistant πŸ€–βš‘
Made with ❀️ for smarter document analysis

About

AI-powered document analysis using Groq Cloud and Llama-3.1-8B-instant

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published