Files
BeyondCXAnalytics-Demo/frontend/QUICK_START.md
2026-02-04 11:08:21 +01:00

190 lines
3.3 KiB
Markdown

# ⚡ Quick Start Guide - Beyond Diagnostic Prototipo
**Status:** ✅ Production Ready | **Date:** 2 Dec 2025
---
## 🚀 3-Second Start
### Windows
```bash
# Double-click:
start-dev.bat
# Or run in terminal:
npm run dev
```
### Mac/Linux
```bash
npm run dev
```
**Then open:** http://localhost:3000
---
## 📁 Project Structure
```
src/
├── components/ → React components
├── utils/ → Business logic & analysis
├── types/ → TypeScript definitions
├── App.tsx → Main app
└── main.tsx → Entry point
```
---
## 🎯 Main Features
| Feature | Status | Location |
|---------|--------|----------|
| **Dashboard** | ✅ | `components/DashboardReorganized.tsx` |
| **Data Upload** | ✅ | `components/SinglePageDataRequestIntegrated.tsx` |
| **Heatmaps** | ✅ | `components/HeatmapPro.tsx` |
| **Economic Analysis** | ✅ | `components/EconomicModelPro.tsx` |
| **Benchmarking** | ✅ | `components/BenchmarkReportPro.tsx` |
| **Roadmap** | ✅ | `components/RoadmapPro.tsx` |
---
## 📊 Data Format
### CSV
```csv
interaction_id,datetime_start,queue_skill,channel,duration_talk,hold_time,wrap_up_time,agent_id,transfer_flag
1,2024-01-15 09:30,Ventas,Phone,240,15,30,AG001,false
```
### Excel
- Same columns as CSV
- Format: .xlsx
- First sheet is used
---
## ⚙️ Configuration
### Environment
- **Port:** 3000 (dev) or 5173 (fallback)
- **Node:** v16+ required
- **NPM:** v7+
### Build
```bash
npm install # Install dependencies
npm run dev # Development
npm run build # Production build
```
---
## 🐛 Troubleshooting
### Port Already in Use
```bash
npm run dev -- --port 3001
```
### Dependencies Not Installing
```bash
rm -rf node_modules
npm install
```
### Build Errors
```bash
rm -rf dist
npm run build
```
---
## 📝 File Types Supported
✅ Excel (.xlsx, .xls)
✅ CSV (.csv)
❌ Other formats not supported
---
## 🔧 Common Commands
| Command | Effect |
|---------|--------|
| `npm run dev` | Start dev server |
| `npm run build` | Build for production |
| `npm run preview` | Preview production build |
| `npm install` | Install dependencies |
| `npm update` | Update packages |
---
## 💾 Important Files
- `package.json` - Dependencies & scripts
- `tsconfig.json` - TypeScript config
- `vite.config.ts` - Vite build config
- `tailwind.config.js` - Tailwind CSS config
---
## 🔐 Security Notes
- ✅ All data validated
- ✅ No external API calls
- ✅ Local file processing only
- ✅ See NOTA_SEGURIDAD_XLSX.md for details
---
## 📚 Documentation
| File | Purpose |
|------|---------|
| `README_FINAL.md` | Project overview |
| `SETUP_LOCAL.md` | Detailed setup |
| `STATUS_FINAL_COMPLETO.md` | Complete audit results |
| `GUIA_RAPIDA.md` | Quick guide |
| `CORRECCIONES_*.md` | Technical fixes |
---
## ✨ Features Summary
```
✅ Responsive Design
✅ Real-time Analytics
✅ Multiple Data Formats
✅ Interactive Charts
✅ Economic Modeling
✅ Benchmarking
✅ 18-month Roadmap
✅ Agentic Readiness Scoring
✅ Error Boundaries
✅ Fallback UI
```
---
## 🎊 You're All Set!
Everything is ready to go. Just run:
```bash
npm run dev
```
And open http://localhost:3000
**Enjoy! 🚀**
---
**Last Updated:** 2 December 2025
**Status:** ✅ Production Ready
**Errors Fixed:** 37/37
**Build:** ✅ Successful