directus-extension-usage-analytics-module/README.md

Visual analytics module for collection storage usage and API request patterns in Directus (Module only - requires API package)

# Directus Usage Analytics - Module

Visual analytics module for collection storage usage and API request patterns in Directus.

> **⚠️ IMPORTANT**: This is the **frontend module only**. The backend API must be installed separately:
> ```bash
> npm install directus-extension-usage-analytics-api
> ```

## 🎯 What's This Package?

This package contains **only the UI module** for the Directus admin interface. It provides:

- ✅ Collection Storage Analytics Dashboard
- ✅ API Activity Monitoring Views
- ✅ Interactive Charts and Statistics
- ✅ Professional Directus-compliant UX

## 📦 Installation

### Option 1: Directus Marketplace (Recommended)

1. Open your Directus admin panel
2. Navigate to **Settings** → **Extensions** → **Marketplace**
3. Search for "usage analytics"
4. Click **Install**

### Option 2: NPM Installation

```bash
npm install directus-extension-usage-analytics-module
```

### Required: Install API Package

The module **requires** the companion API package to function:

```bash
npm install directus-extension-usage-analytics-api
```

### Complete Installation (Both Packages)

```bash
npm install directus-extension-usage-analytics-module directus-extension-usage-analytics-api
```

### Docker Installation

```dockerfile
# In your Dockerfile
RUN npm install directus-extension-usage-analytics-module directus-extension-usage-analytics-api
```

Or in `docker-compose.yml`:

```yaml
services:
  directus:
    image: directus/directus:latest
    volumes:
      - ./extensions:/directus/extensions
    environment:
      EXTENSIONS_AUTO_RELOAD: "true"
```

Then install in your project:

```bash
npm install directus-extension-usage-analytics-module directus-extension-usage-analytics-api
```

## 🚀 Features

### Collection Storage Analytics
- Visual row count tracking for all collections
- System vs user collection filtering
- Interactive bar and pie charts
- Detailed data tables with sortable columns

### API Activity Monitoring
- Request pattern analysis by collection
- Action-based statistics (create, read, update, delete)
- Time-based filtering with date range selection
- IP-based traffic analysis

### User Experience
- Professional Directus design system compliance
- Loading states with skeleton loaders
- Empty states with helpful messages
- Responsive design for mobile and tablet
- WCAG 2.1 AA accessibility compliance
- Table hover effects and smooth transitions

## 📖 Documentation

For full documentation, visit:
- **GitHub Repository**: https://github.com/flagbit/directus-usage-tracker
- **API Package**: https://www.npmjs.com/package/directus-extension-usage-analytics-api

## 🔧 Requirements

- Directus 10.x or 11.x
- Node.js 18+ recommended
- API package installed separately

## 📝 License

MIT License - Copyright © 2024 Flagbit GmbH & Co. KG

## 🤝 Support

- **Issues**: https://github.com/flagbit/directus-usage-tracker/issues
- **Email**: info@flagbit.de
- **Website**: https://www.flagbit.de

## 🎉 Why Split Packages?

This extension is split into two packages for **Directus Marketplace compatibility**:

- **Module Package** (this one): Can be installed via Marketplace
- **API Package** (separate): Requires full Node.js access, manual installation only

This approach gives you the best of both worlds:
- Easy discovery via Marketplace
- Full functionality with API package
- Secure sandbox compliance for Marketplace listing

---

**Made with ❤️ by Flagbit**