====== Apricot ドキュメント ======
Version 1.0 ([[apricot:license|MIT License]])

 --- //[[http://www.y2sunlight.com|y2sunlight]] 2020-07-28//

Apricot は素早く簡単なWebアプリケーションを作るためのPHPによる軽量フレームワークです。Apricot は [[https://github.com/y2sunlight/apricot|GitHub]] で公開しています。

=== 目次 ===

  * [[apricot:usage:ja:features|Apricot 特徴と概要]]
  * [[apricot:usage:ja:config|Apricot 配置と構成]]
  * [[apricot:usage:ja:errors-logging|Apricot ログとエラー処理]]
  * [[apricot:usage:ja:http|Apricot リクエストとレスポンス]]
  * [[apricot:usage:ja:frontend|Apricot フロントエンド]]
  * [[apricot:usage:ja:database|Apricot データベース]]
  * [[apricot:usage:ja:model|Apricot モデルとサービス]]
  * [[apricot:usage:ja:middleware|Apricot ミドルウェア]]
  * [[apricot:usage:ja:controller|Apricot コントローラ]]
  * [[apricot:usage:ja:validation|Apricot バリデーション]]
  * [[apricot:usage:ja:provider|Apricot サービスプロバイダー]]
  * [[apricot:usage:ja:authentication|Apricot ユーザ認証]]
  * [[apricot:usage:ja:utility|Apricot ユーティリティ]]

===== 要件 =====

  * PHP 7.3 以上

使用パッケージ

^機能^パッケージ名^Vsersion^
|環境変数|[[https://github.com/vlucas/phpdotenv|phpdotenv]]|<nowiki>^5.0</nowiki>|
|ログ出力|[[https://github.com/Seldaek/monolog|monolog]]|<nowiki>^2.1</nowiki>|
|リクエストルーター|[[https://github.com/nikic/FastRoute|FastRoute]]|<nowiki>^1.3</nowiki>|
|DIコンテナー|[[https://github.com/thephpleague/container|League/Container]]|<nowiki>^3.3</nowiki>|
|テンプレートエンジン|[[https://github.com/EFTEC/BladeOne|bladeone]]|<nowiki>^3.46</nowiki>|
|エラーハンドラー|[[https://github.com/filp/whoops|Whoops]]|<nowiki>^2.7</nowiki>|
|デバッグ出力|[[https://github.com/maximebf/php-debugbar|php-debugbar]]|<nowiki>^1.16</nowiki>|
|アセット管理|[[https://github.com/kriswallsmith/assetic|assetic]]|<nowiki>^1.4</nowiki>|
|ORマッパー|[[https://github.com/j4mie/idiorm|idiorm]]|<nowiki>^1.5</nowiki>|
|バリデーター|[[https://github.com/vlucas/valitron|Valitron]]|<nowiki>^1.4</nowiki>|

\\

===== インストール =====

次のように、Composerを使用して新しいApricotのプロジェクトを作成することをお勧めします。

<code sh>
composer create-project y2sunlight/apricot your-project-name --dev
</code>

または、次のように手動で作成することもできます。

<code sh>
git clone https://github.com/y2sunlight/apricot your-project-name
cd your-project-name
composer install --dev
</code>

その後 ''.env.sample'' を ''.env'' にコピーします。

<code sh>
cd your-project-name
cp .env.sample .env
</code>

\\

===== クイックスタート =====

新しいApricotプロジェクトを作成したら、すぐに試すことができます。

最初に、プロジェクトフォルダーでPHPのビルドインWebサーバーを起動します。

<code sh>
php -S localhost:8888 -t public
</code>

そして、以下のURLにアクセスしてください。

  * http://localhost:8888/

Apricotプロジェクトの「ログインページ」が表示されるのでログインして下さい。デフォルトのアカウントIDは ''root'' で、パスワードは設定されていません。

\\

===== ライブラリとしての使用 =====

ライブラリーとして使用する場合は、[[https://github.com/y2sunlight/apricot-skeleton|Apricotスケルトン]] を使うことをお薦めします。

=== apricot-skeleton ===

インストール：
<code sh>
composer create-project y2sunlight/apricot-skeleton your-app-name
</code>

スケルトンの作成：
<code sh>
cd your-app-name
php apricot.php build
</code>

スケルトンをインストール後は、上の[[#クイックスタート]]を参照して、すぐに試すことができます。

詳しくは、[[https://github.com/y2sunlight/apricot-skeleton|apricot-skeleton]] を参照して下さい。

\\

===== ライセンス =====

Apricotフレームワークは [[https://ja.wikipedia.org/wiki/MIT_License|MITライセンス]]の下でライセンスされています。詳細については、[[https://github.com/y2sunlight/apricot/blob/master/LICENSE|ライセンスファイル]]を参照してください。

\\