https://github.com/pickles2/app-burdock
PHPサーバー+ブラウザ上で動作する Pickles 2 のGUIツール。
https://github.com/pickles2/app-burdock
Last synced: 2 months ago
JSON representation
PHPサーバー+ブラウザ上で動作する Pickles 2 のGUIツール。
- Host: GitHub
- URL: https://github.com/pickles2/app-burdock
- Owner: pickles2
- Created: 2018-09-10T11:56:33.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2022-12-10T17:32:14.000Z (over 3 years ago)
- Last Synced: 2025-12-14T18:05:25.875Z (6 months ago)
- Language: PHP
- Size: 16.3 MB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# app-burdock
PHPサーバー+ブラウザ上で動作する Pickles 2 のGUIツール。
Pickles Framework 2 に特化した CMSライクなテキストエディタ "Pickles 2" のウェブ版です。
## インストール
### 1. app-burdock の依存ライブラリをインストールする
```
git clone https://github.com/pickles2/app-burdock.git;
cd app-burdock;
composer install;
npm install;
```
### 2. `.env` ファイルを作成、設定する
サンプルの設定ファイル `.env.example` から `.env` という名前で複製します。
```
cp .env.example .env;
```
この設定ファイルに、適宜必要な設定を更新してください。
```
vi .env;
```
#### アプリケーションの基本情報の設定
必要に応じて設定を変更してください。
```
APP_NAME=Burdock
APP_ENV=local
APP_KEY=base64:NOwK3+2AQLj41zWorz0d1JXe7cKSGRTKMtJs9tSm4/g=
APP_DEBUG=true
```
アプリケーションキーは次のコマンドで再生成してください。
```
$ php artisan key:generate;
Application key set successfully.
```
#### アプリサーバーとプレビューサーバーのURLを設定
アプリサーバーとプレビューサーバーは異なるURLを設定してください。
```
APP_URL=https://example.com
BD_PREVIEW_DOMAIN=preview.example.com
BD_STAGING_DOMAIN=staging.example.com
```
#### データベース接続設定
データベースの接続先情報を更新します。
次の例は、SQLite を使用する設定例です。
```
DB_CONNECTION=sqlite
DB_HOST=
DB_PORT=
DB_DATABASE=../bd_data/database.sqlite
DB_USERNAME=
DB_PASSWORD=
```
### プロジェクトを作成するディレクトリパスの設定
プロジェクトは任意のディレクトリにインストールすることができます。
次の例は、Users > hoge > fuga 配下にある path_to_project_dir フォルダにプロジェクトを作成したい場合の設定です。
```
BD_DATA_DIR=/Users/hoge/fuga/path_to_project_dir
```
#### その他
メール送信サーバーなどの設定項目があります。
必要に応じて修正してください。
### 4. データベースを初期化する
```
php artisan migrate --seed;
```
#### データベースシステム に sqlite を利用する場合の注意点
SQLite を使用する場合は、先に 空白のデータベースファイルを作成しておく必要があります。
また、データベースのパスを相対パスで指定したい場合、 migrate コマンド実行時に注意が必要です。
実際のアプリケーションは相対パスの起点が `public/` で実行されます。 migrate コマンドは、これと同じカレントディレクトリで実行される必要があります。
`DB_DATABASE` の値を `public/` 起点の相対パスに設定して、 publicディレクトリ で migrate を実行します。
```
cd public/;
touch ../bd_data/database.sqlite;
php ../artisan migrate --seed;
cd ..;
```
### サーバーを起動して確認する
以上でセットアップは完了です。
次のコマンドを実行してサーバーを起動し、確認してみることができます。
```
php artisan serve;
```
正常に起動したら、 `http://127.0.0.1:8000` でアクセスできます。
ブラウザではじめの画面が表示されたら完了です。
## cron コマンド設定
```
* * * * * apache cd /path/to/burdock && php artisan schedule:run >> /dev/null 2>&1
```
## Redis で WebSocket 環境をセットアップする
WebSocket環境を利用すると、サーバーとの間で非同期に対話する機能を追加できます。 特にパブリッシュなどの時間がかかる処理の利便性が向上します。
このセットアップはオプションです。
Redis と Laravel Echo Server がインストールされている必要があります。
```
brew install redis;
npm install -g laravel-echo-server;
```
Laravel Echo Server をセットアップします。
次のコマンドで質問に答えていくと、 `laravel-echo-server.json` が作成されます。
```
laravel-echo-server init;
```
`.env` ファイルを開き、 `BROADCAST_DRIVER` を `redis` に設定します。
```
BROADCAST_DRIVER=redis
```
## 起動する
次のコマンドで Redis と Laravel Echo Server、 Laravel Queue などを起動します。
```
redis-server --daemonize yes;
pm2 start laravel-echo-server-pm2.json;
pm2 start node/watcher.js;
nohup php artisan queue:work --timeout=30000 > /dev/null 2>&1 &;
```
## artisan コマンド
### indigo:cron
配信予約ツール Indigo の配信処理をキックします。
### bd:deploy-script
Indigo の配信処理の後処理をキックします。
### bd:generate_vhosts
Apache 用の Virtual Hosts の設定ファイルを出力します。
## システム要件 - System Requirement
- PHP 7.1.3 以上
- [mbstring](https://www.php.net/manual/ja/book.mbstring.php) PHP Extension
- [ZipArchive](https://www.php.net/manual/ja/class.ziparchive.php) PHP Extension
- [JSON](https://www.php.net/manual/ja/book.json.php) PHP Extension
- [PDO](https://www.php.net/manual/ja/book.pdo.php) PHP Extension
- [PDO SQLite (PDO_SQLITE)](https://www.php.net/manual/ja/ref.pdo-sqlite.php) PHP Extension
- [XML Parser](https://www.php.net/manual/ja/book.xml.php) PHP Extension
- [XMLWriter](https://www.php.net/manual/ja/book.xmlwriter.php) PHP Extension
- [Ctype](https://www.php.net/manual/ja/book.ctype.php) PHP Extension
- [DOM](https://www.php.net/manual/ja/book.dom.php) PHP Extension
- [Fileinfo](https://www.php.net/manual/ja/book.fileinfo.php) PHP Extension
- [libxml](https://www.php.net/manual/ja/book.libxml.php) PHP Extension
- [Zlib](https://www.php.net/manual/ja/book.zlib.php) PHP Extension
- [OpenSSL](https://www.php.net/manual/ja/book.openssl.php) PHP Extension
- [Tokenizer](https://www.php.net/manual/ja/book.tokenizer.php) PHP Extension
- [BC Math](https://www.php.net/manual/ja/book.bc.php) PHP Extension
### 推奨環境
- PHP 7.2 以上
- [GD](https://www.php.net/manual/ja/book.image.php) PHP Extension
- [iconv](https://www.php.net/manual/ja/book.iconv.php) PHP Extension
- [SimpleXML](https://www.php.net/manual/ja/book.simplexml.php) PHP Extension
- [XMLReader](https://www.php.net/manual/ja/book.xmlreader.php) PHP Extension
- [PDO MySQL (PDO_MYSQL)](https://www.php.net/manual/ja/ref.pdo-mysql.php) PHP Extension
- MySQL 5.7.7 以上
- Node.js 12.16 以上
- Redis
プラグインなど他のパッケージとの構成によって、いくつかの要件が追加される場合があります。
依存パッケージのシステム要件も確認してください。
## 更新履歴 - Change log
### Pickles 2 Burdock v0.1.4 (2021年7月10日)
- `composer update` ができない不具合を修正。
### Pickles 2 Burdock v0.1.3 (2021年6月26日)
- 新規作成した Broccoli コンテンツに、モジュールを配置できない不具合を修正。
### Pickles 2 Burdock v0.1.2 (2021年6月12日)
- 定期バッチに、論理削除された古いデータを、物理削除する処理を追加した。
- 新しい設定項目 `BD_SOFTDELETE_RETENTION_PERIOD`、 `BD_LOG_RETENTION_PERIOD`、 `BD_USER_TEMPORARY_RETENTION_PERIOD` を追加。
- 新しい設定項目 `BD_URL_SCHEME` を追加。
- スペース管理メニューを追加。
- その他の細かい修正。
### Pickles 2 Burdock v0.1.1 (2021年6月7日)
- Git機能で、ステータス情報を表示できない不具合を修正。
- Composer 操作とキャッシュの消去で、結果を表示できない不具合を修正。
- プロジェクト情報の更新時に、再セットアップを促される不具合を修正。
- 本番環境に、自動のホスト名 `{$project_code}---production` を発行するようになった。
- 本番配信予約、配信済み、および バックアップ を閲覧するためのホスト名を発行するようになった。
- `bd:generate_vhosts` の実行間隔を 1時間毎 に変更した。
- コンテンツの編集方法を変更できるようになった。
- コンテンツエディタを、 viewport `width=1366` に変更した。
- ファイルとフォルダ で、Pickles 2 プロジェクトの準備が整っていない場合に、いくつかのCRUD操作ができない不具合を修正。
- プロジェクトの `$conf->plugins->px2dt->main_menu` に対応。メインメニューをプロジェクト毎にカスタマイズできるようになった。
- プロジェクトの `$conf->plugins->px2dt->appearance->main_color` に対応。
- ファイルのアップロードダイアログが操作できない不具合を修正。
- その他の細かい修正。
### Pickles 2 Burdock v0.1.0 (2021年5月28日)
- プレビュー環境の区切り文字を ハイフン4つ に変更した。
- `BD_PREVIEW_DOMAIN` と `BD_STAGING_DOMAIN` は、ワイルドーカードを使えるようになった。
- Project Code は、先頭を半角英数字で始まらなければいけないようになった。
- 新しい設定項目 `BD_APP_COPYRIGHT` を追加。
### Pickles 2 Burdock v0.0.1 (2021年5月25日)
- Initial Release.
## ライセンス - License
MIT License
## 開発者向け情報 - for Developer
### データベースへのダミーデータシーディング
```
$ php artisan db:seed --class=DummyDataSeeder
```