Laravel-ChartJS 项目启动与配置教程

1. 项目目录结构及介绍

Laravel-ChartJS 是一个为 Laravel 应用程序提供 Chart.js 图表库支持的简单包装器。以下是项目的目录结构及其简介：

laravel-chartjs/
├── .gitattributes         # Git 属性文件
├── .gitignore            # Git 忽略文件
├── composer.json         # Composer 配置文件
├── composer.lock         # Composer 锁文件
├── package-lock.json     # npm 包锁定文件
├── pint.json             # Pint 配置文件
├── README.md             # 项目自述文件
├── SECURITY.md           # 安全策略文件
├── config/               # 配置文件目录
│   └── chartjs.php       # ChartJS 配置文件
├── docs/                 # 文档目录
├── src/                  # 源代码目录
│   ├── ...
│   └── ...
├── tests/                # 测试目录
└── vite.config.js        # Vite 配置文件

2. 项目的启动文件介绍

项目的启动主要通过 composer.json 文件进行。以下是 composer.json 的基本内容介绍：

{
    "name": "icehouse-ventures/laravel-chartjs",
    "description": "Simple package to facilitate and automate the use of charts in Laravel using the Chart.js library.",
    "require": {
        "php": "^7.3|^8.0",
        "icehouse-ventures/laravel-chartjs": "^1.0"
    },
    "autoload": {
        "psr-4": {
            "IcehouseVentures\\LaravelChartjs\\": "src/"
        }
    },
    "extra": {
        "laravel": {
            "providers": [
                "IcehouseVentures\\LaravelChartjs\\Providers\\ChartjsServiceProvider"
            ]
        }
    }
}

要启动项目，你需要在 Laravel 项目中运行以下命令：

composer require icehouse-ventures/laravel-chartjs

对于 Laravel 8 及以下版本，你还需要在 config/app.php 文件中注册服务提供者：

'providers' => [
    // ...
    IcehouseVentures\LaravelChartjs\Providers\ChartjsServiceProvider::class,
]

3. 项目的配置文件介绍

项目的配置主要通过 config/chartjs.php 文件进行。以下是 config/chartjs.php 的基本内容介绍：

return [
    // ChartJS 库的版本
    'version' => '4.1.0',

    // ChartJS 文件的交付方式
    'delivery' => 'custom',

    // ChartJS 的 CDN 链接，如果使用 CDN 交付方式
    'cdn' => [
        '2.9.3' => 'https://cdn.jsdelivr.net/npm/chart.js@2.9.3/dist/Chart.min.js',
        '3.5.1' => 'https://cdn.jsdelivr.net/npm/chart.js@3.5.1/dist/Chart.min.js',
        '4.1.0' => 'https://cdn.jsdelivr.net/npm/chart.js@4.1.0/dist/Chart.min.js',
    ],
];

在 config/chartjs.php 文件中，你可以自定义 Chart.js 的版本和交付方式。例如，如果你希望使用 CDN 方式来加载 Chart.js，你可以将 'delivery' 设置为 'CDN' 并选择适当的版本。

此外，你还可以通过发布配置文件来进一步自定义包的设置：

php artisan vendor:publish --provider="IcehouseVentures\LaravelChartjs\Providers\ChartjsServiceProvider" --tag="config"

这样，你就可以在 config/chartjs.php 文件中调整设置了。