Skip to content

Commit

Permalink
docs: LTI Tool Consumer 追加手順を記載
Browse files Browse the repository at this point in the history
  • Loading branch information
kou029w committed Feb 3, 2021
1 parent cf73464 commit 95744a4
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 10 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# GakuNinLMS-LTI-MC

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%2Fnpocccties%2FChibiCHiLO&env=NEXT_PUBLIC_API_BASE_PATH,API_BASE_PATH,FRONTEND_ORIGIN,FRONTEND_PATH,SESSION_SECRET,OAUTH_CONSUMER_KEY,OAUTH_CONSUMER_SECRET,DATABASE_URL)
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%2Fnpocccties%2FChibiCHiLO&env=NEXT_PUBLIC_API_BASE_PATH,API_BASE_PATH,FRONTEND_ORIGIN,FRONTEND_PATH,SESSION_SECRET,DATABASE_URL)

GakuNinLMS-LTI-MC, utilizing LTI, is a system that can create and browse learning contents using micro contents.

Expand Down
41 changes: 32 additions & 9 deletions server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,8 @@ docker-compose down
| `FRONTEND_ORIGIN` | フロントエンドのオリジン (例: `http://localhost:3000`) |
| `FRONTEND_PATH` | フロントエンドのパス (例: `http://localhost:3000/` ならば `/`) |
| `SESSION_SECRET` | セッションストアの秘密鍵 |
| `OAUTH_CONSUMER_KEY` | LMS に登録されている OAuth Consumer Key |
| `OAUTH_CONSUMER_SECRET` | LMS に登録されている OAuth Consumer Secret |
| `OAUTH_CONSUMER_KEY` | LMS に登録する OAuth Consumer Key (デフォルト: 無効) |
| `OAUTH_CONSUMER_SECRET` | LMS に登録する OAuth Consumer Secret (デフォルト: 無効) |
| `DATABASE_URL` | [PostgreSQL 接続 URL][database_connection_url] |
| `HTTPS_CERT_PATH` | HTTPS を使うための証明書のファイルパス (デフォルト: 無効) |
| `HTTPS_KEY_PATH` | HTTPS を使うための証明書の秘密鍵のファイルパス (デフォルト: 無効) |
Expand All @@ -82,20 +82,43 @@ docker-compose down

## 本番環境へのデプロイ

### 前提

フロントエンドの静的ファイルを生成し public ディレクトリ以下に配置します。
加えて、サーバー上のデータベースはあらかじめマイグレートしておく必要があります。

### ビルド

次のコマンドを実行してビルドします
次のコマンドを実行し、フロントエンドの静的ファイルを生成し public ディレクトリ以下に配置します

```sh
https://github.com/npocccties/ChibiCHiLO.git
yarn
yarn build
```

dist ディレクトリ以下に作られたファイルが作られれば成功です。
server/dist ディレクトリ以下にファイルが作られれば成功です。

### データベースのマイグレーション

データベースのマイグレーションを行います。

```sh
cd server
echo 'DATABASE_URL={PostgreSQL 接続 URL}' >> .env
yarn migrate
```

### LTI Tool Consumer の設定

マイグレーション後、接続する PostgreSQL に対して、次の SQL を実行し、LTI Tool Consumer の設定を行います。

```sql
INSERT INTO "lti_consumer" VALUES ('{LMS に登録する OAuth Consumer Key}', '{LMS に登録する OAuth Consumer Secret}');
```

#### ヒント: PostgreSQL への接続

[psql コマンド](https://www.postgresql.org/docs/current/app-psql.html) を使うことで接続できます。

```sh
psql "$DATABASE_URL"
```

### 起動

Expand Down

0 comments on commit 95744a4

Please sign in to comment.