Go to file
shibafu c680cd8d8e Merge branch 'develop' into feature/300-incoming-webhook
# Conflicts:
#	package.json
#	webpack.mix.js
#	yarn.lock
2020-08-20 09:24:28 +09:00
.circleci eslintの仮構成 2020-06-06 17:37:01 +09:00
.github Create dependabot.yml 2020-06-02 22:58:11 +09:00
app Merge branch 'develop' into feature/300-incoming-webhook 2020-08-20 09:24:28 +09:00
bootstrap Laravel 5.7 2020-05-23 21:34:54 +09:00
config Add Sentry integration 2020-07-16 22:11:42 +09:00
database Merge branch 'develop' into feature/300-incoming-webhook 2020-08-06 23:28:30 +09:00
dist IDEからのデバッグ実行用ラッパーを追加 2020-02-16 19:34:45 +09:00
public 2020-07-17 22:23:37 +09:00
resources Merge branch 'develop' into feature/300-incoming-webhook 2020-08-20 09:24:28 +09:00
routes impl settings page 2020-07-23 22:26:34 +09:00
storage Laravel 5.7 2020-05-23 21:34:54 +09:00
tests Merge branch 'develop' into feature/300-incoming-webhook 2020-08-20 09:24:28 +09:00
.dockerignore ドッカーン 2018-06-05 23:45:29 +09:00
.editorconfig add api document 2020-07-21 23:18:39 +09:00
.env.example Add Sentry integration 2020-07-16 22:11:42 +09:00
.eslintrc.js fix eslint 2020-08-17 16:19:14 +09:00
.gitattributes Dockerコンテナ内にXdebugを導入 (#33) 2019-01-16 00:42:05 +09:00
.gitignore add api document 2020-07-21 23:18:39 +09:00
.php_cs.dist php-cs-fixer のルールに single_quote を追加 (#54) 2019-01-18 20:00:47 +09:00
.prettierrc リーナスも80文字は短いみたいなこといってたし120文字でええやろ 2020-06-06 17:51:17 +09:00
.stylelintignore .stylelintignoreを追加 2019-06-17 07:10:08 +09:00
Dockerfile Docker: use php-intl 2020-07-30 23:04:53 +09:00
LICENSE Initial Commit 2017-08-27 04:44:53 +09:00
README.md Update README 2020-05-24 12:02:34 +09:00
artisan Initial Commit 2017-08-27 04:44:53 +09:00
composer.json add extension requirements 2020-07-31 22:21:31 +09:00
composer.lock add extension requirements 2020-07-31 22:21:31 +09:00
docker-compose.debug.yml docker-compose.debug.ymlを追加 (#55) 2019-01-18 20:00:24 +09:00
docker-compose.mailcatcher.yml add mailcatcher (#112) 2019-02-26 22:50:47 +09:00
docker-compose.yml Dockerコンテナ内にXdebugを導入 (#33) 2019-01-16 00:42:05 +09:00
openapi.yaml add api document 2020-07-21 23:18:39 +09:00
package.json Merge branch 'develop' into feature/300-incoming-webhook 2020-08-20 09:24:28 +09:00
phpunit.xml Laravel 5.6 2020-05-23 20:32:24 +09:00
prepare.sh LaravelドキュメントのDeploymentsに書かれているコマンドを実行するスクリプト 2018-09-11 23:19:41 +09:00
server.php Initial Commit 2017-08-27 04:44:53 +09:00
tsconfig.json esModuleInterop 2020-08-17 18:17:38 +09:00
webpack.mix.js Merge branch 'develop' into feature/300-incoming-webhook 2020-08-20 09:24:28 +09:00
yarn.lock Merge branch 'develop' into feature/300-incoming-webhook 2020-08-20 09:24:28 +09:00

README.md

Tissue

a.k.a. shikorism.net

シコリズムネットにて提供している夜のライフログサービスです。 (思想的には shibafu528/SperMaster の後継となります)

構成

  • Laravel 6
  • Bootstrap 4.4.1

実行環境

  • PHP 7.3
  • PostgreSQL 9.6

開発環境の構築

Docker を用いた開発環境の構築方法です。

  1. .env ファイルを用意します。.env.example をコピーすることで用意ができます。

  2. Docker イメージをビルドします

docker-compose build
  1. Docker コンテナを起動します。
docker-compose up -d
  1. Composer と yarn を使い必要なライブラリをインストールします。
docker-compose exec web composer install
docker-compose exec web yarn install
  1. 暗号化キーの作成と、データベースのマイグレーションを行います。
docker-compose exec web php artisan key:generate
docker-compose exec web php artisan migrate
  1. ファイルに書き込めるように権限を設定します。
docker-compose exec web chown -R www-data /var/www/html/storage
  1. アセットをビルドします。
docker-compose exec web yarn dev
  1. 最後に .env を読み込み直すために起動し直します。
docker-compose up -d

これで準備は完了です。Tissue が動いていれば http://localhost:4545/ でアクセスができます。

デバッグ実行

docker-compose -f docker-compose.yml -f docker-compose.debug.yml up -d

で起動することにより、DB のポート5432を開放してホストマシンから接続できるようになります。

アセットのリアルタイムビルド

yarn watchを使うとソースファイルを監視して差分があると差分ビルドしてくれます。フロント開発時は活用しましょう。

docker-compose run --rm web yarn watch

もしファイル変更時に更新されない場合はyarn watch-pollを試してみてください。
現在Docker環境でのHMRはサポートしてません。Docker外ならおそらく動くでしょう。
その他詳しくはlaravel-mixのドキュメントなどを当たってください。

phpunit によるテスト

変更をしたらPull Requestを投げる前にテストが通ることを確認してください。
テストは以下のコマンドで実行できます。

docker-compose exec web composer test

環境構築上の諸注意

  • 初版時点では、DB サーバとして PostgreSQL を使うよう .env ファイルを設定するくらいです。 当分、PostgreSQL から変える気はないので専用 SQL 等を平気で使います。