Skip to content

Latest commit

 

History

History
86 lines (60 loc) · 2.35 KB

README.ja.md

File metadata and controls

86 lines (60 loc) · 2.35 KB
Raw

Synk Calendar

Synk Calendarは、Google Calendarの内容を表示するためのWebアプリケーションです。

シフトの共有やプライベートイベントの共有など、「無料でカレンダーの表示だけできるようにしたい」というユースケースを想定し、開発されています。

機能

  • Google Calendarとの連携
  • 月表示、週表示、4日表示、日表示の切り替え
  • モバイル/PC対応
  • イベントの詳細表示
  • リマインダー (Experimental)
  • 多言語対応 (i18n)

技術スタックと利用ライブラリ

  • TypeScript
  • React
  • Remix
  • Google Calendar API
  • FullCalendar

開発環境のセットアップ

  1. リポジトリをクローンします：
git clone https://github.com/yamitzky/synk-calendar.git
cd synk-calendar
  1. 依存関係をインストールします：
pnpm install
  1. 環境変数を設定します。.envファイルを作成し、必要な変数を設定してください：
# サービスアカウントのファイルパスを指定してください
GOOGLE_APPLICATION_CREDENTIALS=path/to/your/credentials.json
[email protected],id2,id3
# Google Workspace の場合はドメイン全体の委任と委任先のアドレス設定が必要です https://developers.google.com/admin-sdk/directory/v1/guides/delegation
[email protected]
# 以降の環境変数は、リマインダーを使う場合のみ必要です
REMINDER_SETTINGS=[{"minutesBefore":10,"notificationType":"console"},{"minutesBefore":30,"notificationType":"webhook"}]
WEBHOOK_URL=https://your-webhook-url.com
# リマインダーのテンプレート文をカスタマイズしたい場合は設定してください(Eta)
REMINDER_TEMPLATE="Reminder: <%= it.title %> starts in <%= it.minutesBefore %> minutes."
  1. 開発サーバーを起動します：
pnpm dev

アプリケーションは http://localhost:5173で利用可能になります。

ビルドと本番環境での実行

  1. アプリケーションをビルドします：
pnpm build
  1. 本番環境でアプリケーションを実行します：
pnpm start

テスト

テストを実行するには：

pnpm test

ライセンス

このプロジェクトはMITライセンスの下で公開されています。