Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pepabo/colormeshop-wp-plugin
A WordPress plugin to integrate Colorme Shop.
https://github.com/pepabo/colormeshop-wp-plugin
Last synced: about 1 month ago
JSON representation
A WordPress plugin to integrate Colorme Shop.
- Host: GitHub
- URL: https://github.com/pepabo/colormeshop-wp-plugin
- Owner: pepabo
- License: gpl-2.0
- Created: 2017-04-04T04:16:14.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-08-19T02:44:12.000Z (5 months ago)
- Last Synced: 2024-08-19T03:33:40.263Z (5 months ago)
- Language: PHP
- Size: 3.7 MB
- Stars: 13
- Watchers: 80
- Forks: 5
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# カラーミーショップ WordPress プラグイン
WordPress で [カラーミーショップ](https://shop-pro.jp/) に登録している商品情報を扱ったり、商品ページを自動生成することができるプラグインです :muscle:
## 利用方法
当プラグインは [カラーミーショップ API](https://developer.shop-pro.jp/docs/colorme-api) を利用して商品情報などを取得しています。
そのため、予め下記に登録していただき、発行された情報を WordPress 管理画面で入力してください。
- [カラーミーショップデベロッパーアカウント](https://developer.shop-pro.jp/sign_up)
- [カラーミーショップアプリ作成](https://developer.shop-pro.jp/my/private_application/new)
## 動作環境
PHP 7.3 以上
## 一緒に開発しませんか？
当プラグインについて、お気づきの点やアイデアをお持ちのかたはぜひ開発にご参加ください。
また、「こんな機能あったら良さそうなんだけど、どうでしょう？」といったお話も大歓迎ですので気軽に [Issues](https://github.com/pepabo/colormeshop-wp-plugin/issues) に投稿してみましょう!
### 開発の流れ
1. このリポジトリに Star をつける (重要です! :sparkles: )
1. 自分のリポジトリにフォーク
1. ブランチを切る (`git checkout -b my-new-feature`)
1. 変更をコミット (`git commit -am 'Add some feature`)
1. ブランチをプッシュ (`git push origin my-new-feature`)
1. Pull Request を作成
### すぐに開発を始められます
[docker](https://www.docker.com/) 用のコンテナ定義ファイル `docker-compose.yml` を用意していますので、ローカル環境にすばやく WordPress を立ち上げてプラグインの開発を始められます。
```
$ cp wp.env.sample wp.env
$ docker-compose up -d
$ open http://localhost:8080
```
## 開発ガイド
### コーディング規約
PHP_CodeSniffer の WordPress 用ルールセットである [WordPress-Coding-Standards](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards) を利用しています。
また、PHPの互換性をチェックするために、[PHPCompatibility](https://github.com/PHPCompatibility/PHPCompatibility)も利用しています。
これらの設定は、[ruleset.xml](./ruleset.xml)にあります。以下のコマンドで、phpcsによるチェックや自動変換を行うことができます。
```
# 規約チェック
$ docker-compose run composer vendor/bin/phpcs --standard=ruleset.xml
# インデントなどは自動整形できます
$ docker-compose run composer vendor/bin/phpcbf --standard=ruleset.xml
```
### APIクライアント
[Swagger Codegen](https://github.com/swagger-api/swagger-codegen) で生成したAPIクライアントを利用していて、[`src/Swagger`](https://github.com/pepabo/colormeshop-wp-plugin/tree/master/src/Swagger) に配置しています。
APIクライアントを更新する場合は下記のコマンドを実行してください。
```shell-session
$ make generate_api_client
```
### モデルやショートコードを追加したけどオートロードされない場合は
[dump-autoload](https://getcomposer.org/doc/03-cli.md#dump-autoload) を実行してクラスマップを再生成してください。
WordPress の命名規則は [PSR](http://www.php-fig.org/psr/psr-4/) と異なるので、[classmap](https://getcomposer.org/doc/04-schema.md#classmap) を利用しています。
```
$ docker-compose run --rm composer dump-autoload
```
### ユニットテスト
docker コンテナ内でユニットテストを実行するためのスクリプトを用意しています。
```
$ tests/run.sh
```
初回実行時はテスト環境のインストールが走るので少し時間がかかります。
### ビルド
Dockerfile.buildで作成したコンテナを使って、zipファイルを作成します。
```
$ make
```