onramplab/elevenlabs-api-client

ElevenLabs API 客户端

v1.0.1 2023-09-27 09:39 UTC

This package is auto-updated.

Last update: 2024-09-27 12:06:49 UTC


README

Software License CircleCI Total Downloads

需求

  • PHP >= 7.4;
  • composer.

特性

  • PSR-4 自动加载兼容结构;
  • PSR-2 代码风格兼容;
  • 使用 PHPUnit 6 进行单元测试;
  • 全面的指南和教程;
  • 易于使用,适用于任何框架或纯 PHP 文件;
  • 包含实用工具以优化代码。

安装

composer require onramplab/elevenlabs-api-client

这将为您创建一个基本的项目结构

  • /build 默认用于存储代码覆盖率输出;
  • /src 是您的代码存放的地方,每个类都需要位于此文件夹内的自己的文件中;
  • /tests 中的每个类在将其“包含”到其他地方之前都需要进行测试。因此,我们基本上在那里有测试类来测试其他类;
  • .gitignore 有一些我们不希望在 Git 中发布的文件,所以我们只需将它们添加到该文件中,以便它们“被 Git 忽略”;
  • CHANGELOG.md 用于跟踪包更新;
  • CONTRIBUTION.md 贡献者公约代码行为准则;
  • LICENSE 其他程序员可以使用此库的自由程度;
  • README.md 这是库的迷你文档,如果您的库已发布在 GitHub 和 Packagist 上,这是您的 repo 的“主页”;
  • composer.json 存储有关您库的信息,例如包名称、作者和依赖项;
  • phpunit.xml 这是 PHPUnit 的配置文件,以便测试类能够测试您编写的类;
  • .travis.yml Travis CI 的基本配置,配置了代码覆盖率的代码气候报告。

有关更多信息,请参阅原始 文章

实用工具

运行测试

php vendor/bin/phpunit

composer test

代码检查工具

php vendor/bin/phpcs --standard=PSR2 src/

composer psr2check

代码自动修复器

composer psr2autofix
composer insights:fix
composer rector:fix

构建文档

php vendor/bin/phpdoc -d "src" -t "docs"

composer docs

更改日志

为了跟踪,请参阅 CHANGELOG.md

贡献

  1. 将其分叉。
  2. 创建您的功能分支(git checkout -b my-new-feature)。
  3. 进行更改。
  4. 运行测试,如有必要,为您的代码添加新测试(phpunit)。
  5. 提交更改(git commit -am 'Added some feature')。
  6. 将分支推送到远程仓库(git push origin my-new-feature)。
  7. 创建新的 pull request。

也请参阅 CONTRIBUTION.md

许可

请参阅 LICENSE