doc更新 (#209)

* README更新

* 証明書云々をREADMEから除去

* Update CONTRIBUTING.md

CONTRIBUTING.md

@@ -103,6 +103,26 @@ sudo make format
 sudo make test
 ```
 
+## マイグレーション
+1. .env に本番環境の情報を追加
+```
+echo "DB_USERNAME=[username]" >> .env
+echo "DB_PASSWORD=[password]" >> .env
+echo "DB_HOST=[host]" >> .env
+echo "DB_NAME=[database name]" >> .env
+```
+2. SSL証明書(`DigiCertGlobalRootCA.crt.pem`)の配置
+    - [Download the public SSL certificate - Azure Database for MySQL - Flexible Server | Microsoft Learn](https://learn.microsoft.com/en-gb/azure/mysql/flexible-server/how-to-connect-tls-ssl#download-the-public-ssl-certificate) から証明書を取得する。
+    - `DigiCertGlobalRootCA.crt.pem` を`/api`に含める。
+3. テーブルの更新
+```
+docker compose exec api alembic revision --autogenerate -m "update tables"
+```
+4. テーブルの更新を反映
+```
+alembic upgrade head
+```
+
 ## GitHub Actions
 ### Workflows
 - ci.yml

README.md

@@ -63,11 +63,7 @@ sudo make create-table
 6. localhost でドキュメントを開いてみましょう
 http://localhost/docs
 
-7. SSL証明書(`DigiCertGlobalRootCA.crt.pem`)の配置
-    - [Download the public SSL certificate - Azure Database for MySQL - Flexible Server | Microsoft Learn](https://learn.microsoft.com/en-gb/azure/mysql/flexible-server/how-to-connect-tls-ssl#download-the-public-ssl-certificate) から証明書を取得する。
-    - `DigiCertGlobalRootCA.crt.pem` を`/api`に含める。
-
-8. コンテナの停止
+7. コンテナの停止
 ```
 sudo make stop
 ```
@@ -129,15 +125,14 @@ sudo make stop
 │       └── conf.d
 │           └── app.conf
 ├── api
-│   ├── DigiCertGlobalRootCA.crt.pem
 │   ├── alembic
 │   │   ├── README
 │   │   ├── env.py
 │   │   ├── script.py.mako
 │   │   └── versions
-│   │       ├── 46c6ca5a18f2_init.py
-│   │       └── c0a3f6001efc_initialize_tables.py
 │   ├── alembic.ini
+│   ├── config.py
+│   ├── db-cert.pem
 │   ├── db.py
 │   ├── main.py
 │   ├── migrate_db.py
@@ -147,62 +142,33 @@ sudo make stop
 │   │   ├── __init__.py
 │   │   ├── audio1.wav
 │   │   ├── conftest.py
+│   │   ├── cruds
+│   │   │   └── conftest.py
 │   │   ├── test_v1_raspi.py
+│   │   ├── test_v2_raspi.py
 │   │   └── test_v2_user.py
 │   ├── uploads
 │   ├── v0
-│   │   ├── __init__.py
-│   │   ├── routers
-│   │   │   ├── __init__.py
-│   │   │   └── raspi.py
-│   │   ├── services
-│   │   │   ├── __init__.py
-│   │   │   ├── gpt.py
-│   │   │   ├── tts.py
-│   │   │   ├── voicevox.py
-│   │   │   ├── voicevox_api.py
-│   │   │   └── whisper.py
-│   │   └── utils
-│   │       ├── __init__.py
-│   │       └── config.py
 │   ├── v1
-│   │   ├── __init__.py
-│   │   ├── routers
-│   │   │   ├── __init__.py
-│   │   │   ├── raspi.py
-│   │   │   └── sandbox.py
-│   │   ├── schemas
-│   │   │   ├── __init__.py
-│   │   │   └── sandbox.py
-│   │   ├── services
-│   │   │   ├── __init__.py
-│   │   │   ├── assistants
-│   │   │   │   ├── __init__.py
-│   │   │   │   └── assistants
-│   │   │   │       └── create.py
-│   │   │   ├── gpt.py
-│   │   │   ├── gpt_backup.py
-│   │   │   ├── voicevox_api.py
-│   │   │   └── whisper.py
-│   │   └── utils
-│   │       ├── __init__.py
-│   │       ├── cheering.txt
-│   │       ├── config.py
-│   │       └── logging.py
 │   └── v2
 │       ├── __init__.py
+│       ├── azure
 │       ├── cruds
 │       │   ├── __init__.py
 │       │   ├── couple.py
+│       │   ├── raspi.py
 │       │   └── user.py
 │       ├── models
 │       │   ├── __init__.py
 │       │   ├── couple.py
 │       │   ├── message.py
+│       │   ├── raspi.py
 │       │   └── user.py
 │       ├── routers
 │       │   ├── __init__.py
 │       │   ├── couple.py
+│       │   ├── demo.py
+│       │   ├── pubsub.py
 │       │   ├── raspi.py
 │       │   └── user.py
 │       ├── schemas
@@ -212,15 +178,22 @@ sudo make stop
 │       │   ├── sandbox.py
 │       │   └── user.py
 │       ├── services
-│       │   └── __init__.py
+│       │   ├── __init__.py
+│       │   ├── blob_storage.py
+│       │   ├── gpt.py
+│       │   ├── pubsub.py
+│       │   ├── voicevox_api.py
+│       │   └── whisper.py
 │       └── utils
 │           ├── __init__.py
-│           ├── config.py
+│           ├── file_search.txt
+│           ├── index.html
 │           ├── logging.py
 │           └── query.py
 ├── docker-compose.dev.yml
 ├── docker-compose.yml
-└── init_mysql.sh
+├── init_mysql.sh
+└── ws_client.py
 ```
 
 ## VOICEVOX