sim1222 / exdeck-backend

Backend for EXDeck (Birdseye)

Backend for EXDeck

EXDeckは、軽量なマルチカラムのTwitterクライアントです。

関連リポジトリ

• フロントエンド exdeck-frontend
• バックエンド exdeck-backend (このリポジトリ)

必要要件

• Node.js Version Manager (fnmを推奨)
• Node.js LTS
• pnpm

インストール

以下のコマンドを実行します。

git clone https://github.com/EXDeck/exdeck-backend.git
cd exdeck-backend
pnpm install

使い方

.envファイルを作成します。 .envでは以下の内容が設定可能です。 これらのうちCKおよびCSは設定が必須です。他の項目は必要に応じて設定してください。

CK=[your twitter API consumer key]
CS=[your twitter API consumer secret]
ORIGIN=[frontend origin / defalut: https://localhost:3000]
PORT=[listening port / defalut: 3000]
SSL=[using SSL (true/false)]
C_HTTPONLY=[cookie http only option (true/false)]
C_SECURE=[cookie secure option (true/false)]
C_SAMESITE=[cookie samesite option (strict/lax/none) / default: strict]
C_DOMAIN=[cookie domain option]
C_MAXAGE=[cookie max age option]

ローカルのSSL証明書を使用する場合は以下の手順で証明書を発行してください。

1. mkcertのインストール
2. mkcert --install && mkcert localhost

開発用サーバーの起動

以下のコマンドを実行します。

pnpm dev

サーバーの起動

以下のコマンドを実行します。

pnpm bs

ビルド

以下のコマンドを実行します。

pnpm build

ライセンス

Copyright (c) 2022 EXDeck https://github.com/EXDeck

このソフトウェアは、MIT Licenseに基づき配布しています。