docs: ドキュメントを更新

flocon-trpg · Nov 13, 2022 · b20b313 · b20b313
1 parent dd4061e
commit b20b313
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 3 deletions.
diff --git a/README_developer.md b/README_developer.md
@@ -15,6 +15,10 @@ Flocon
 ┃ ┣ 📦 eslint-config
 ┃ ┣ 📦 flocon-script
 ┃ ┣ 📦 prettier-config
+┃ ┣ 📦 rollup-config
+┃ ┣ 📦 sdk
+┃ ┣ 📦 sdk-react
+┃ ┣ 📦 sdk-urql
 ┃ ┣ 📦 tsconfig
 ┃ ┣ 📦 typed-document-node-v0.7.1
 ┃ ┣ 📦 typed-document-node-v0.7.2
@@ -31,6 +35,13 @@ Flocon
 
 現時点では watch スクリプトはありません。ご了承ください。
 
+## 必要動作環境
+
+(Netlify や fly.io にデプロイする場合は必要ありません)
+
+-   yarn のインストール
+-   Node.js v14, v16, v18 のいずれかのインストール
+
 ## ローカルでの API サーバーの実行方法
 
 [環境変数のセット](https://flocon.app/docs/server/details/api-server/vars)が必須です。また、環境変数のセットにおいて、Firebase プロジェクトの準備も必要になります。
@@ -127,9 +138,9 @@ Redis を使用したテストは`./packages/cache`パッケージにのみ存
 
 リレーショナルデータベースを使用したテストは [api-server](./apps/api-server) パッケージにのみ存在します。このパッケージをテストしない場合は`MYSQL_TEST`、`POSTGRESQL_TEST`、`SQLITE_TEST`の値は利用されません。
 
-#### Node.js 14 以前における web-server パッケージのテスト
+#### Node.js v14 における web-server パッケージのテスト
 
-`web-server` のコードには String.prototype.replaceAll メソッドが含まれています。このメソッドは多くのブラウザや Node.js 16 などでは対応していますが、Node.js 14 などでは未対応です。このため、Node.js 14 では web-server パッケージの一部のテストに失敗します。なお、Node.js 14 で問題が生じるのはテストのみであり、`yarn run dev`、`yarn run build`、`yarn run export` などは正常に動作すると思われます。
+`web-server` のコードには String.prototype.replaceAll メソッドが含まれています。このメソッドは多くのブラウザや Node.js v16 などでは実装されていますが、Node.js v14 では未実装です。このため、Node.js 14 では web-server パッケージの一部のテストに失敗します。なお、Node.js v14 で問題が生じるのはテストのみであり、`yarn run dev`、`yarn run build`、`yarn run export` などは正常に動作すると思われます。
 
 ## licenses-npm-package.txt の生成に関して
 

diff --git a/packages/eslint-config/README.md b/packages/eslint-config/README.md
@@ -0,0 +1,3 @@
+# eslint-config
+
+eslint の config ファイルです。
diff --git a/packages/prettier-config/README.md b/packages/prettier-config/README.md
@@ -0,0 +1,3 @@
+# prettier-config
+
+prettier の config ファイルです。
diff --git a/packages/rollup-config/README.md b/packages/rollup-config/README.md
@@ -0,0 +1,3 @@
+# rollup-config
+
+Rollup の config ファイルです。
diff --git a/packages/sdk/README.md b/packages/sdk/README.md
@@ -2,4 +2,4 @@
 
 Web サーバーの SDK です。3rd-party の Web サーバーを作成する際に用いると便利です。
 
-**現時点ではアルファ版です。予告なしで頻繁に破壊的変更がなされることが予想されます。現段階では 3rd-party の Web サーバーの作成はあまりお勧めできません。**
+**SDK は現時点ではアルファ版です。予告なしで頻繁に破壊的変更がなされることが予想されます。現段階では 3rd-party の Web サーバーの作成はあまりお勧めできません。**
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# eslint-config

		eslint の config ファイルです。
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# prettier-config

		prettier の config ファイルです。
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# rollup-config

		Rollup の config ファイルです。
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,4 @@

		Web サーバーの SDK です。3rd-party の Web サーバーを作成する際に用いると便利です。

		現時点ではアルファ版です。予告なしで頻繁に破壊的変更がなされることが予想されます。現段階では 3rd-party の Web サーバーの作成はあまりお勧めできません。
		SDK は現時点ではアルファ版です。予告なしで頻繁に破壊的変更がなされることが予想されます。現段階では 3rd-party の Web サーバーの作成はあまりお勧めできません。