Download the PHP package arpanihan/auditify without Composer

Auditify - Laravel Action and Activity Log Package

Auditify is a flexible and easy-to-use package for Laravel that allows you to log Action Logs (system-level actions like CRUD operations) and Activity Logs (frontend user interactions like page visits, button clicks, etc.). The package is highly configurable and can be easily integrated into any Laravel project.

✨ Key Features

• � Action Logging: Track system-level operations (CRUD actions, logins, etc.)
• 👆 Activity Logging: Monitor user interactions (page visits, button clicks, tab switches)
• 🎯 Frontend JavaScript Integration: Automatic frontend activity tracking
• ⚙️ Fully Configurable: Customize table names, log types, pagination via config
• 🛡️ Safe Installation: No foreign key constraints, configurable table names
• 📊 API Ready: JSON endpoints for custom frontends
• 🚀 Laravel 9+ Compatible: Works with modern Laravel versions

� Requirements

• PHP >= 8.0
• Laravel >= 9.0
• Composer

🚀 Installation

🟢 Recommended: Safe Installation (All Projects)

This command will:

• ✅ Check for table conflicts before creating anything
• ✅ Publish config with safe defaults
• ✅ Run only Auditify migrations (not your existing ones)
• ✅ Publish assets safely
• ✅ Provide clear feedback on each step

🔍 Check Installation Status

🟡 Alternative: Manual Installation (Advanced Users)

If you prefer manual control or need specific migration paths:

📋 Get Specific Migration Paths

🔴 ❌ AVOID: Full Migration Command

⚠️ DO NOT USE in existing projects:

Instead use:

⚙️ Configuration

The package comes with a comprehensive configuration file. After publishing, you can modify config/auditify.php:

Environment Variables

You can also use environment variables in your .env file:

Running Migrations

After publishing the migration files, you can run the migrations for Auditify separately from your existing migrations to avoid conflicts with your project’s database.

To run only the Auditify migrations, use the following command:

This will apply only the Auditify migrations and will not interfere with any other migrations in your project. Ensure that your_auditify_migration_folder points to the correct folder where Auditify migrations are located.

If you want to run all migrations, including your project migrations, simply use:

However, we recommend running the package-specific migrations to avoid any issues.

Configuration

After publishing the config file, you can modify the config/auditify.php file to suit your needs.

Example Configuration (config/auditify.php):

Dynamic Configuration

• Activity Log Events: You can enable or disable specific events like page visits, tab switches, modal openings, and button clicks.
• Action Log Modules: Specify the modules you want to track, such as user, product, order, report. Add or remove modules as needed.
• Table Names: You can customize the table names for both activity logs and action logs.
• Pagination: Adjust the number of logs per page using the pagination section.
• Log Retention: Optionally delete older logs after a specified number of days (e.g., after 365 days).

📚 Usage

Action Logging

Log system-level operations like CRUD actions, logins, etc:

Activity Logging

Log user interactions and frontend activities:

Frontend JavaScript Integration

Automatically track frontend activities with the included JavaScript module:

Using Facades

You can also use the package facades for cleaner code:

🔗 API Endpoints

The package provides API endpoints for external integrations:

🛠️ Troubleshooting

Common Issues & Solutions

❌ "Table already exists" Error

Problem: Migration fails because table names conflict with existing tables.

Solution:

❌ "Migration ran all my migrations"

Problem: Used php artisan migrate instead of safe installation.

Solution:

❌ "Config not found" Error

Problem: Configuration file not published.

Solution:

❌ JavaScript not working

Problem: Assets not published.

Solution:

Quick Commands Reference

🧪 Testing

The package is thoroughly tested. Run tests in your Laravel project:

Example Test

ActivityLogger::log('tab_switch', 'Switched to settings tab', null, 'Settings'); ActivityLogger::log('modal_open', 'Opened user profile modal', null, 'Users');

Logging an Activity

To log user activities (e.g., page visits, button clicks, etc.), use the ActivityLogger service.

Frontend Activity Logging (JavaScript)

The Auditify package includes a JavaScript file (activityLog.js) for logging frontend activities. You can include it in your Blade views.

Example Usage:

Customizing the JavaScript Path

If you prefer to use a custom path for the activityLog.js file, simply modify the activity_js_path key in config/auditify.php.

🔧 Advanced Configuration

Custom Table Names

Avoid conflicts by customizing table names in your .env file:

Disabling Routes

If you want to use only the logging functionality without web routes:

Role Resolution

The package safely resolves user roles. If you have a custom Role model:

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

This package is open-sourced software licensed under the MIT license.

👨‍💻 Author

ArpaNihan

• Email: [email protected]
• GitHub: @arpanihan

📊 Package Stats

• Minimum PHP: 8.0+
• Laravel Compatibility: 9.0+
• Dependencies: Minimal (only illuminate/support)
• Database: MySQL, PostgreSQL, SQLite compatible
• File Size: Lightweight package

Ready to track every action in your Laravel app? Install Auditify today! 🚀