Report Generator

A comprehensive SQL-based report generation and scheduling platform with a modern React frontend and NestJS backend.

🚀 Features

• Database Connections: Connect to PostgreSQL, MySQL, SQL Server, Oracle, SQLite
• SQL Query Editor: Write and test SQL queries with syntax highlighting
• Report Scheduling: Cron-based scheduling with timezone support
• Multiple Output Formats: CSV, Excel (XLS/XLSX), PDF, JSON, XML
• Report Routing: Automatic email and FTP delivery
• User Management: Role-based access control (Admin, Report Manager, Viewer)
• Execution History: Track all report executions with detailed logs
• AI Assistant: Optional AI-powered query generation and debugging

📋 Prerequisites

• Node.js 18+
• npm 8+
• Docker & Docker Compose (recommended for database services)
• PostgreSQL 15+ (if not using Docker)
• Redis 7+ (if not using Docker)

🛠 Quick Installation

Option 1: Automated Setup (Recommended)

# Clone the repository
git clone <repository-url>
cd Moez

# Run the installation script
./install.sh

Option 2: Manual Setup

1. Install Dependencies

# Install all dependencies
npm install
cd backend && npm install
cd ../frontend && npm install
cd ..

2. Start Database Services

# Using Docker
docker compose up -d postgres redis

# Or manually install PostgreSQL and Redis

3. Configure Environment

Create backend/.env:

DATABASE_URL="postgresql://postgres:postgres@localhost:5433/report_gen?schema=public"
JWT_SECRET="your-super-secret-jwt-key-change-in-production"
JWT_EXPIRATION="7d"
REDIS_HOST="localhost"
REDIS_PORT="6379"
STORAGE_PATH="./storage"
FRONTEND_URL="http://localhost:5173"
ENCRYPTION_KEY="0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"

4. Setup Database

cd backend
npx prisma generate
npx prisma db push
mkdir -p storage

5. Start Development Servers

# Terminal 1 - Backend
cd backend
npm run start:dev

# Terminal 2 - Frontend
cd frontend
npm run dev

🐳 Docker Deployment

Development with Docker

# Start all services
docker compose up

# Or start specific services
docker compose up -d postgres redis
docker compose up backend frontend

Production Deployment

# Build and start production containers
docker compose -f docker-compose.prod.yml up -d

📁 Project Structure

Moez/
├── backend/                 # NestJS Backend
│   ├── src/
│   │   ├── auth/           # Authentication (JWT)
│   │   ├── connections/    # Database connections
│   │   ├── reports/        # Report management
│   │   ├── schedules/      # Scheduling (Cron)
│   │   ├── executions/     # Execution history
│   │   ├── output/         # File generation (CSV, Excel, etc.)
│   │   ├── routing/        # Email/FTP delivery
│   │   ├── users/          # User management
│   │   ├── groups/         # Group management
│   │   └── bot/            # AI assistant
│   └── prisma/             # Database schema
├── frontend/               # React Frontend (Vite)
│   ├── src/
│   │   ├── components/     # Reusable UI components
│   │   ├── pages/          # Page components
│   │   ├── contexts/       # React contexts
│   │   └── lib/            # Utilities & API
│   └── public/
├── docker-compose.yml      # Docker configuration
├── install.sh              # Installation script
└── README.md

🔑 Default Ports

Service	Port
Frontend	5173
Backend	3000
PostgreSQL	5433
Redis	6379

📚 API Documentation

Swagger documentation is available at:

http://localhost:3000/api/docs

🎯 Usage

1. Create a Database Connection

Navigate to Connections → New Connection and configure:

• Connection name
• Database type (PostgreSQL, MySQL, etc.)
• Host, port, username, password, database

2. Create a Report

Navigate to Reports → New Report:

• Select a connection
• Write your SQL query
• Test the query
• Choose output format (CSV, Excel, PDF, etc.)

3. Execute Report

• Manual: Click the ▶️ Play button on the Reports page
• Scheduled: Create a schedule with cron expression

4. Download Results

Navigate to Executions and click Download on successful executions.

🔐 User Roles

Role	Permissions
ADMIN	Full access to all features
REPORT_MANAGER	Create/edit reports, connections, schedules
VIEWER	View and execute reports only

🛡 Security

• JWT-based authentication
• Password hashing with bcrypt
• Database credentials encryption
• Role-based access control
• SQL injection prevention through parameterized queries

📧 Email Configuration (Optional)

To enable email delivery, configure SMTP in the routing settings:

• SMTP Host
• Port (25, 465, 587)
• Username/Password
• TLS/SSL options

🤝 Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Submit a pull request

📄 License

MIT License - see LICENSE file for details.

🆘 Support

For issues and feature requests, please create an issue on GitHub.