craftsmancoding / repo-starter
Requires
- php: >=5.3
This package is not auto-updated.
Last update: 2024-09-24 01:36:02 UTC
README
这是一个用于构建 MODX 包的入门套件的兼容 Repoman 的 MODX 包演示仓库。
安装
要将此包作为 Repoman 项目的起点下载，请使用 composer create-project
composer create-project craftsmancoding/repo-starter --prefer-dist
这将把包拉到您的本地计算机上，您可以从修改它开始。
如果您不熟悉 Composer，请参阅下面的安装 Composer 部分。
设置
一旦下载了包，您可能需要修改 composer.json 以匹配您的厂商名（通常是您的 Github 或 Bitbucket 用户名），您的包名（这通常对应于 MODX 命名空间）。删除任何不需要的目录或部分（例如，如果您的包不需要安装任何插件，请删除 elements/plugins/ 目录。这些文件夹仅包含在 repo-start 中，以提供示例。
对于版本 1，您需要单独下载 Repoman 工具： https://github.com/craftsmancoding/repoman 请参阅 https://github.com/craftsmancoding/repoman/wiki/Installation 了解安装 Repoman 的说明。
一旦通过删除不需要的元素修改了 repo-starter，并准备好将包内容与 MODX 同步以便开始开发，您需要使用 Repoman 来安装您的包
php repoman install /path/to/your/package
您可以根据环境调整 repoman 工具或包目录的路径。
编辑 composer.json
更新 composer.json 文件以引用您自定义的厂商和包名。
配置 Git
一旦您准备好开始版本控制项目，您需要调整一些设置以使起始仓库与其根源分离。
安装 Composer
如果您是第一次尝试使用 Composer，那么我们表示同情：它并不总是那么容易上手。
通常最简单的方法是下载 Composer PHAR 文件并使用它来执行命令。请参阅 https://getcomposer.org/download/ 了解下载 .phar 包的示例。
curl -sS https://getcomposer.org/installer | php
或
php -r "readfile('https://getcomposer.org/installer');" | php
一旦您有了 composer.phar 文件，修改 create-project 命令以引用它，例如：
php composer.phar create-project craftsmancoding/repo-starter --stability=dev