mirror of
https://github.com/kjanat/livedash-node.git
synced 2026-01-16 12:12:09 +01:00
refactor: fix biome linting issues and update project documentation
- Fix 36+ biome linting issues reducing errors/warnings from 227 to 191 - Replace explicit 'any' types with proper TypeScript interfaces - Fix React hooks dependencies and useCallback patterns - Resolve unused variables and parameter assignment issues - Improve accessibility with proper label associations - Add comprehensive API documentation for admin and security features - Update README.md with accurate PostgreSQL setup and current tech stack - Create complete documentation for audit logging, CSP monitoring, and batch processing - Fix outdated project information and missing developer workflows
This commit is contained in:
151
README.md
151
README.md
@ -1,6 +1,6 @@
|
||||
# LiveDash-Node
|
||||
|
||||
A real-time analytics dashboard for monitoring user sessions and interactions with interactive data visualizations and detailed metrics.
|
||||
A comprehensive real-time analytics dashboard for monitoring user sessions with AI-powered analysis, enterprise-grade security features, and advanced processing pipeline.
|
||||
|
||||
.*%22&replace=%24%3Cversion%3E&logo=nextdotjs&label=Nextjs&color=%23000000>)
|
||||
.*%22&replace=%24%3Cversion%3E&logo=react&label=React&color=%2361DAFB>)
|
||||
@ -10,28 +10,45 @@ A real-time analytics dashboard for monitoring user sessions and interactions wi
|
||||
|
||||
## Features
|
||||
|
||||
### Core Analytics
|
||||
- **Real-time Session Monitoring**: Track and analyze user sessions as they happen
|
||||
- **Interactive Visualizations**: Geographic maps, response time distributions, and more
|
||||
- **Advanced Analytics**: Detailed metrics and insights about user behavior
|
||||
- **User Management**: Secure authentication with role-based access control
|
||||
- **Customizable Dashboard**: Filter and sort data based on your specific needs
|
||||
- **Session Details**: In-depth analysis of individual user sessions
|
||||
- **Interactive Visualizations**: Geographic maps, response time distributions, and advanced charts
|
||||
- **AI-Powered Analysis**: OpenAI integration with 50% cost reduction through batch processing
|
||||
- **Advanced Analytics**: Detailed metrics and insights about user behavior patterns
|
||||
- **Session Details**: In-depth analysis of individual user sessions with transcript parsing
|
||||
|
||||
### Security & Admin Features
|
||||
- **Enterprise Security**: Multi-layer security with CSRF protection, CSP, and rate limiting
|
||||
- **Security Monitoring**: Real-time threat detection and alerting system
|
||||
- **Audit Logging**: Comprehensive security audit trails with retention management
|
||||
- **Admin Dashboard**: Advanced administration tools for user and system management
|
||||
- **Geographic Threat Detection**: IP-based threat analysis and anomaly detection
|
||||
|
||||
### Platform Management
|
||||
- **Multi-tenant Architecture**: Company-based data isolation and management
|
||||
- **User Management**: Role-based access control with platform admin capabilities
|
||||
- **Batch Processing**: Optimized AI processing pipeline with automated scheduling
|
||||
- **Data Export**: CSV/JSON export capabilities for analytics and audit data
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- **Frontend**: React 19, Next.js 15, TailwindCSS 4
|
||||
- **Backend**: Next.js API Routes, Node.js
|
||||
- **Database**: Prisma ORM with SQLite (default), compatible with PostgreSQL
|
||||
- **Authentication**: NextAuth.js
|
||||
- **Visualization**: Chart.js, D3.js, React Leaflet
|
||||
- **Data Processing**: Node-cron for scheduled tasks
|
||||
- **Backend**: Next.js API Routes, tRPC, Custom Node.js server
|
||||
- **Database**: PostgreSQL with Prisma ORM and connection pooling
|
||||
- **Authentication**: NextAuth.js with enhanced security features
|
||||
- **Security**: CSRF protection, CSP with nonce-based scripts, comprehensive rate limiting
|
||||
- **AI Processing**: OpenAI API with batch processing for cost optimization
|
||||
- **Visualization**: D3.js, React Leaflet, Recharts, custom chart components
|
||||
- **Monitoring**: Real-time security monitoring, audit logging, threat detection
|
||||
- **Data Processing**: Node-cron schedulers for automated batch processing and AI analysis
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Node.js (LTS version recommended)
|
||||
- Node.js 18+ (LTS version recommended)
|
||||
- pnpm (recommended package manager)
|
||||
- PostgreSQL 13+ database
|
||||
|
||||
### Installation
|
||||
|
||||
@ -48,50 +65,114 @@ cd livedash-node
|
||||
pnpm install
|
||||
```
|
||||
|
||||
3. Set up the database:
|
||||
3. Set up environment variables:
|
||||
|
||||
```bash
|
||||
pnpm run prisma:generate
|
||||
pnpm run prisma:migrate
|
||||
pnpm run prisma:seed
|
||||
cp .env.example .env.local
|
||||
# Edit .env.local with your configuration
|
||||
```
|
||||
|
||||
4. Start the development server:
|
||||
4. Set up the database:
|
||||
|
||||
```bash
|
||||
pnpm run dev
|
||||
pnpm prisma:generate
|
||||
pnpm prisma:migrate
|
||||
pnpm prisma:seed
|
||||
```
|
||||
|
||||
5. Open your browser and navigate to <http://localhost:3000>
|
||||
5. Start the development server:
|
||||
|
||||
```bash
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
6. Open your browser and navigate to <http://localhost:3000>
|
||||
|
||||
## Environment Setup
|
||||
|
||||
Create a `.env` file in the root directory with the following variables:
|
||||
Create a `.env.local` file in the root directory with the following variables:
|
||||
|
||||
```env
|
||||
DATABASE_URL="file:./dev.db"
|
||||
NEXTAUTH_URL=http://localhost:3000
|
||||
NEXTAUTH_SECRET=your-secret-here
|
||||
# Database Configuration
|
||||
DATABASE_URL="postgresql://user:password@localhost:5432/livedash"
|
||||
DATABASE_URL_DIRECT="postgresql://user:password@localhost:5432/livedash"
|
||||
|
||||
# Authentication
|
||||
NEXTAUTH_URL="http://localhost:3000"
|
||||
NEXTAUTH_SECRET="your-nextauth-secret-key"
|
||||
|
||||
# AI Processing (optional - for AI features)
|
||||
OPENAI_API_KEY="your-openai-api-key"
|
||||
|
||||
# Security Configuration
|
||||
CSRF_SECRET="your-csrf-secret-key"
|
||||
|
||||
# Scheduler Configuration (optional)
|
||||
SCHEDULER_ENABLED="true"
|
||||
CSV_IMPORT_INTERVAL="*/10 * * * *"
|
||||
IMPORT_PROCESSING_INTERVAL="*/5 * * * *"
|
||||
SESSION_PROCESSING_INTERVAL="*/2 * * * *"
|
||||
BATCH_PROCESSING_INTERVAL="*/1 * * * *"
|
||||
|
||||
# Batch Processing (optional)
|
||||
BATCH_PROCESSING_ENABLED="true"
|
||||
BATCH_CREATE_INTERVAL="*/5 * * * *"
|
||||
BATCH_STATUS_CHECK_INTERVAL="*/2 * * * *"
|
||||
BATCH_RESULT_PROCESSING_INTERVAL="*/1 * * * *"
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
|
||||
- `app/`: Next.js App Router components and pages
|
||||
- `app/`: Next.js App Router pages and API routes
|
||||
- `api/`: API endpoints including admin, security, and tRPC routes
|
||||
- `dashboard/`: Main analytics dashboard pages
|
||||
- `platform/`: Platform administration interface
|
||||
- `components/`: Reusable React components
|
||||
- `lib/`: Utility functions and shared code
|
||||
- `pages/`: API routes and server-side code
|
||||
- `prisma/`: Database schema and migrations
|
||||
- `public/`: Static assets
|
||||
- `docs/`: Project documentation
|
||||
- `admin/`: Administrative dashboard components
|
||||
- `security/`: Security monitoring UI components
|
||||
- `forms/`: CSRF-protected forms and form utilities
|
||||
- `providers/`: Context providers (CSRF, tRPC, themes)
|
||||
- `lib/`: Core utilities and business logic
|
||||
- Security modules (CSRF, CSP, rate limiting, audit logging)
|
||||
- Processing pipelines (batch processing, AI analysis)
|
||||
- Database utilities and authentication
|
||||
- `server/`: tRPC server configuration and routers
|
||||
- `prisma/`: Database schema, migrations, and seed scripts
|
||||
- `tests/`: Comprehensive test suite (unit, integration, E2E)
|
||||
- `docs/`: Detailed project documentation
|
||||
- `scripts/`: Migration and utility scripts
|
||||
|
||||
## Available Scripts
|
||||
|
||||
- `pnpm run dev`: Start the development server
|
||||
- `pnpm run build`: Build the application for production
|
||||
- `pnpm run start`: Run the production build
|
||||
- `pnpm run lint`: Run ESLint
|
||||
- `pnpm run format`: Format code with Prettier
|
||||
- `pnpm run prisma:studio`: Open Prisma Studio to view database
|
||||
### Development
|
||||
- `pnpm dev`: Start development server with all features
|
||||
- `pnpm dev:next-only`: Start Next.js only (no background schedulers)
|
||||
- `pnpm build`: Build the application for production
|
||||
- `pnpm start`: Run the production build
|
||||
|
||||
### Code Quality
|
||||
- `pnpm lint`: Run ESLint
|
||||
- `pnpm lint:fix`: Fix ESLint issues automatically
|
||||
- `pnpm format`: Format code with Prettier
|
||||
- `pnpm format:check`: Check code formatting
|
||||
|
||||
### Database
|
||||
- `pnpm prisma:studio`: Open Prisma Studio to view database
|
||||
- `pnpm prisma:migrate`: Run database migrations
|
||||
- `pnpm prisma:generate`: Generate Prisma client
|
||||
- `pnpm prisma:seed`: Seed database with test data
|
||||
|
||||
### Testing
|
||||
- `pnpm test`: Run all tests (Vitest + Playwright)
|
||||
- `pnpm test:vitest`: Run unit and integration tests
|
||||
- `pnpm test:coverage`: Run tests with coverage reports
|
||||
- `pnpm test:security`: Run security-specific tests
|
||||
- `pnpm test:csp`: Test CSP implementation
|
||||
|
||||
### Security & Migration
|
||||
- `pnpm migration:backup`: Create database backup
|
||||
- `pnpm migration:health-check`: Run system health checks
|
||||
- `pnpm test:security-headers`: Test HTTP security headers
|
||||
|
||||
## Contributing
|
||||
|
||||
|
||||
Reference in New Issue
Block a user