Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

12 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Self Service Dashboard AI

AI-powered Self Service Dashboard with PygWalker integration and Ollama-based intelligent dashboard generation

License: MIT Node.js Python React Ollama

πŸš€ Quick Start

One-Command Setup

# Clone the repository
git clone <your-repo-url>
cd SelfServiceDashboard-TM

# One-command setup
./setup.sh

# Install Ollama (interactive)
./scripts/install-ollama.sh

# Start development environment
./scripts/start-development.sh

# Open http://localhost:3000

✨ Features

πŸ€– AI-Powered Dashboard Generation

  • Natural Language to Dashboard: Describe what you want, AI creates it
  • Ollama Integration: Local LLM for privacy and speed
  • Streamlit Dashboards: Interactive, professional dashboards
  • Real-time Generation: Watch your ideas come to life

πŸ“Š Interactive Analytics

  • PygWalker Integration: Drag-and-drop data visualization
  • Multiple Data Sources: Excel files, REST APIs, databases
  • Terminal Manager Optimized: Built for operational data
  • Real-time Performance: No timeouts, smooth interactions

πŸ”§ Developer Friendly

  • Zero Configuration: Works out of the box
  • Hot Reload: All services support development mode
  • Comprehensive Scripts: Health checks, deployment, reset
  • Cross-Platform: macOS, Linux, Windows (WSL)

πŸ“ Project Structure

SelfServiceDashboard-TM/
β”œβ”€β”€ setup.sh                     # 🎯 One-command setup
β”œβ”€β”€ package.json                 # πŸ“¦ Workspace configuration
β”œβ”€β”€ .env.example                 # πŸ”§ Environment template
β”œβ”€β”€ docker-compose.yml           # 🐳 Optional Docker setup
β”‚
β”œβ”€β”€ frontend/                    # βš›οΈ React Frontend
β”‚   β”œβ”€β”€ src/components/
β”‚   β”‚   β”œβ”€β”€ AIDashboardGenerator.js  # πŸ€– AI dashboard component
β”‚   β”‚   └── LoadingStates.js         # πŸ”„ Shared loading components
β”‚   └── src/StandaloneChart.js       # πŸ“Š Main visualization component
β”‚
β”œβ”€β”€ ai-backend/                  # 🧠 AI Backend (Python/Flask)
β”‚   β”œβ”€β”€ app.py                   # 🌐 Flask server
β”‚   β”œβ”€β”€ config.py                # βš™οΈ Configuration management
β”‚   β”œβ”€β”€ requirements.txt         # πŸ“‹ Python dependencies
β”‚   β”œβ”€β”€ install.sh              # πŸ”§ Auto setup script
β”‚   └── test_connection.py      # πŸ” Ollama connection test
β”‚
β”œβ”€β”€ simple-backend/              # πŸ”§ Simple Backend (Node.js)
β”‚   └── (existing backend)       # πŸ“‘ REST API endpoints
β”‚
β”œβ”€β”€ scripts/                     # πŸ› οΈ Management Scripts
β”‚   β”œβ”€β”€ start-development.sh     # πŸš€ Start dev environment
β”‚   β”œβ”€β”€ start-production.sh      # 🏭 Start production mode
β”‚   β”œβ”€β”€ health-check.sh          # πŸ” System health verification
β”‚   β”œβ”€β”€ install-ollama.sh        # πŸ¦™ Ollama installation helper
β”‚   └── reset-project.sh         # πŸ”„ Clean project reset
β”‚
β”œβ”€β”€ docs/                        # πŸ“š Documentation
β”‚   β”œβ”€β”€ SETUP.md                # πŸ“‹ Detailed setup guide
β”‚   β”œβ”€β”€ TROUBLESHOOTING.md       # πŸ”§ Common issues & solutions
β”‚   └── API.md                  # πŸ“– AI backend API docs
β”‚
└── generated-dashboards/        # πŸ“Š Runtime generated dashboards

πŸ”§ Requirements

System Requirements

  • Node.js 16+ and npm 8+
  • Python 3.8+ and pip3
  • Git (recommended)
  • Ollama (for AI features)

Ports Used

  • 3000 - Frontend (React)
  • 5246 - Simple Backend (Node.js)
  • 5247 - AI Backend (Python/Flask)
  • 8501+ - Generated Streamlit dashboards
  • 11434 - Ollama (if installed)

πŸ“– Documentation

πŸ› οΈ Available Scripts

Development

npm run start              # Start development environment
npm run health            # Run health checks
./scripts/health-check.sh  # Detailed system health check

Production

npm run start:prod        # Start production environment
npm run build:frontend    # Build frontend for production

Maintenance

npm run reset             # Reset project (interactive)
./scripts/reset-project.sh --full    # Full reset
./scripts/reset-project.sh --quick   # Quick reset

AI Backend

cd ai-backend
./install.sh             # Setup Python environment
./test_connection.py     # Test Ollama connection
python app.py            # Start AI backend directly

πŸ€– AI Dashboard Examples

Natural Language Prompts

"Create a sales performance dashboard with regional comparisons"
"Build an operational efficiency dashboard with KPIs and uptime metrics"
"Generate a financial overview with profit margins and cost analysis"
"Show fuel volume analysis with environmental impact metrics"

Generated Features

  • Interactive Charts: Plotly-powered visualizations
  • Real-time Data: Live connection to your data sources
  • Professional Styling: Terminal Manager branding
  • Export Options: Multiple formats supported
  • Responsive Design: Works on all devices

πŸ” Health Monitoring

The project includes comprehensive health monitoring:

# Quick health check
./scripts/health-check.sh

# Development mode check
./scripts/health-check.sh --dev-mode

# Setup mode check (during installation)
./scripts/health-check.sh --setup-mode

Monitors:

  • βœ… System requirements (Node.js, Python, etc.)
  • βœ… Project structure and files
  • βœ… Environment setup (virtual envs, dependencies)
  • βœ… Ollama installation and connectivity
  • βœ… Port availability
  • βœ… Service health (in dev/prod mode)

🐳 Docker Support

Optional Docker setup for containerized deployment:

# Start with Docker Compose
docker-compose up

# Development with hot reload
docker-compose -f docker-compose.dev.yml up

πŸ”’ Environment Variables

Copy .env.example to .env and customize:

# AI Backend Configuration
OLLAMA_URL=http://localhost:11434
AI_BACKEND_PORT=5247
OLLAMA_MODEL=llama3

# Frontend Configuration
REACT_APP_AI_BACKEND_URL=http://localhost:5247

# Development Configuration
NODE_ENV=development
LOG_LEVEL=info

🀝 Contributing

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Make your changes
  4. Run tests: ./scripts/health-check.sh
  5. Commit changes: git commit -m 'Add amazing feature'
  6. Push to branch: git push origin feature/amazing-feature
  7. Open a Pull Request

πŸ“ License

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

πŸ†˜ Support

  • Issues: Report bugs or request features in GitHub Issues
  • Documentation: Check docs/ for detailed guides
  • Health Check: Run ./scripts/health-check.sh for diagnostics

πŸ™ Acknowledgments

  • PygWalker - Drag-and-drop visualization engine
  • Ollama - Local LLM infrastructure
  • Streamlit - Dashboard generation framework
  • React - Frontend framework
  • Flask - Backend API framework

🎯 Built for Terminal Manager Operations | πŸš€ Powered by AI | πŸ’» Ready for Production

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages