bizanalyst-ai
v1.0.1
Published
Open source data analyst tool with AI-powered insights
Maintainers
Readme
BizAnalyst AI
Open Source Business Data Analyst with AI-Powered Insights
A professional-grade, open-source Business Data analysis tool for automated data cleaning, visualization, and AI-powered insights.
Features • Installation • Usage • Contributing • License
📊 Features
- Interactive Visualizations - Distributions, correlations, trends, and scatter plots
- AI-Powered Insights - Ask questions about your data using generative AI
- Smart Data Cleaning - Professional auto-clean with outlier detection and imputation
- Multiple File Formats - Support for CSV and Excel files (.csv, .xlsx, .xls)
- Export Charts - Download any visualization as high-quality PNG
- Presentation Mode - Clean, distraction-free view for presentations
- Global Filters - Filter data across all views simultaneously
- Predictive Forecasting - Time series forecasting capabilities
📦 Installation
Option 1: Clone from GitHub
git clone https://github.com/anonymous243/BizAnalyst-AI
cd BizAnalyst-AI
npm installOption 2: Download ZIP
- Click Code → Download ZIP on GitHub
- Extract the ZIP file
- Run
npm installin the extracted folder
Option 3: Install via npm
npm install -g bizanalyst-aiOption 4: Use npx (No Installation)
npx bizanalyst-ai🚀 Usage
1. Set Up Environment
cp .env.example .env.localEdit .env.local and add your API key:
GEMINI_API_KEY=your_api_key_hereGet your free API key from Google AI Studio
2. Start Development Server
npm run devOpen your browser to http://localhost:3001
3. Upload Your Data
- Click Upload CSV/XLSX or drag and drop a file
- Review auto-generated insights
- Use one-click cleaning actions if needed
- Explore visualizations across different tabs
- Ask the AI Analyst questions about your data
- Download charts using the 📷 camera icon
📋 Available Scripts
| Command | Description |
|---------|-------------|
| npm run dev | Start development server |
| npm run build | Build for production |
| npm run preview | Preview production build |
| npm run lint | Run TypeScript type checking |
| npm run clean | Remove build artifacts |
🏗️ Architecture
Technology Stack
- Frontend Framework: React 19 with TypeScript
- Build Tool: Vite
- Styling: Tailwind CSS
- Visualization: Recharts
- AI Integration: Google Gemini API
- Data Processing: Papa Parse (CSV), XLSX (Excel)
- Icons: Lucide React
Project Structure
bizanalyst-ai/
├── src/
│ ├── App.tsx # Main application component
│ ├── analyst.ts # Data analysis utilities
│ ├── types.ts # TypeScript type definitions
│ └── lib/
│ └── utils.ts # Utility functions
├── .github/ # GitHub templates and workflows
├── bin/ # CLI executables
├── dist/ # Production build output
└── docs/ # Documentation files🤝 Contributing
We welcome contributions! Please see our Contributing Guide for details.
Quick Start for Contributors
# Fork the repository
# Clone your fork
git clone https://github.com/anonymous243/BizAnalyst-AI
cd BizAnalyst-AI
# Install dependencies
npm install
# Create a branch
git checkout -b feature/your-feature-name
# Make changes and test
npm run dev
# Commit using conventional commits
git commit -m "feat: add your feature description"
# Push and create PR
git push origin feature/your-feature-nameWays to Contribute
- 🐛 Report bugs and suggest features
- 📝 Improve documentation
- 💻 Submit pull requests
- 🔍 Review code changes
- 💬 Help others in issues
📄 License
This project is licensed under the Apache License 2.0.
🔒 Security
API Key Security
⚠️ Important: This application requires an API key for AI features.
- Never commit your API key to version control
- Use
.env.localfor local development (already gitignored) - For production, implement a backend proxy
- Monitor API usage for unusual activity
See SECURITY.md for our full security policy.
Reporting Vulnerabilities
Please report security vulnerabilities responsibly. Do not create public issues for security concerns. See SECURITY.md for reporting guidelines.
📞 Support
- Documentation: See files in this repository
- Issues: GitHub Issues
- Discussions: GitHub Discussions
🙏 Acknowledgments
Built with amazing open source libraries:
- React - UI framework
- Recharts - Charting library
- Tailwind CSS - Styling
- Lucide Icons - Icon library
- Papa Parse - CSV parsing
- XLSX - Excel file processing
Made with ❤️
