目次

Apricot ドキュメント

Version 1.0 (MIT License)

y2sunlight 2020-07-28

Apricot は素早く簡単なWebアプリケーションを作るためのPHPによる軽量フレームワークです。Apricot は GitHub で公開しています。

目次

要件

使用パッケージ

機能パッケージ名Vsersion
環境変数phpdotenv^5.0
ログ出力monolog^2.1
リクエストルーターFastRoute^1.3
DIコンテナーLeague/Container^3.3
テンプレートエンジンbladeone^3.46
エラーハンドラーWhoops^2.7
デバッグ出力php-debugbar^1.16
アセット管理assetic^1.4
ORマッパーidiorm^1.5
バリデーターValitron^1.4


インストール

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

composer create-project y2sunlight/apricot your-project-name --dev

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

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

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

cd your-project-name
cp .env.sample .env


クイックスタート

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

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

php -S localhost:8888 -t public

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

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


ライブラリとしての使用

ライブラリーとして使用する場合は、Apricotスケルトン を使うことをお薦めします。

apricot-skeleton

インストール:

composer create-project y2sunlight/apricot-skeleton your-app-name

スケルトンの作成:

cd your-app-name
php apricot.php build

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

詳しくは、apricot-skeleton を参照して下さい。


ライセンス

Apricotフレームワークは MITライセンスの下でライセンスされています。詳細については、ライセンスファイルを参照してください。