simbajirira/admin-dashboard

为Laravel提供的管理仪表板包

v0.0.1 2023-10-23 00:49 UTC

This package is auto-updated.

Last update: 2024-09-23 02:51:23 UTC


README

这是一个由Laravel 10、Livewire 3和TailwindCSS驱动的功能丰富的分析仪表板。该仪表板提供实时分析、错误日志记录和多个网站的运行时间监控。它还包含一个角色和权限系统,以增强安全性和用户管理。

目录

  1. 功能
  2. 技术栈
  3. 先决条件
  4. 安装
  5. 配置
  6. 数据库设置
  7. 实时分析
  8. 错误日志
  9. 运行时间监控
  10. 角色和权限
  11. API集成
  12. 测试
  13. 部署
  14. 许可证

功能

  • 实时分析:追踪用户行为、页面浏览量和其他关键指标。
  • 错误日志:实时监控和记录错误。
  • 运行时间监控:监控多个网站及其页面的可用性。
  • 角色和权限:内置用户角色和权限系统。

技术栈

  • 后端:Laravel 10
  • 前端:Livewire 3 + TailwindCSS
  • 实时:Laravel Websockets
  • 数据库:MySQL
  • 测试:PHPUnit

先决条件

  • PHP >= 7.4
  • Composer
  • Node.js和NPM
  • MySQL

安装

# Clone the repository
git clone https://github.com/simba-jirira/AdminDashboard.git

# Navigate to project directory
cd AdminDashboard

# Install PHP dependencies
composer install

# Install JavaScript dependencies
npm install

# Build assets
npm run dev

配置

# Copy environment file
cp .env.example .env

# Generate application key
php artisan key:generate

数据库设置

.env文件中配置数据库凭证。然后,运行以下命令

# Run migrations
php artisan migrate

# Seed database with roles and permissions
php artisan db:seed --class=UserRolePermissionSeeder

实时分析

此功能使用Laravel Websockets。要启动Websockets服务器

php artisan websockets:serve

错误日志

错误将被捕获并在仪表板上实时显示。您可以在.env文件中设置要记录的错误级别。

运行时间监控

系统定期检查以监控网站的运行时间。您可以配置检查间隔和警报机制。

角色和权限

角色定义

  • 管理员:对仪表板有完全访问权限,包括分析、错误日志和运行时间监控。
  • 编辑器:可以查看分析和错误日志,但不能管理用户或运行时间设置。
  • 查看者:对分析有只读访问权限。

用法

使用UserRolePermissionSeeder将角色和权限种入数据库。

php artisan db:seed --class=UserRolePermissionSeeder

API集成

您还可以通过RESTful API访问分析和日志。API文档可在/api/docs找到。

测试

我们使用PHPUnit进行测试。

# Run tests
php artisan test

部署

有关将项目部署到不同环境的说明,请参阅DEPLOYMENT.md文件。

许可证

本项目采用MIT许可证。