user service

Ansopediaユーザーサービス

Ansopediaユーザーサービスは、Ansopedia Learningプラットフォーム内でユーザーアカウントと認証の管理を担当するバックエンドサービスです。次のような機能を提供します。

• ユーザーの登録とログイン：ユーザーが新しいアカウントを作成し、プラットフォームに安全にログインできるようにします。
• ユーザー管理：ユーザープロファイル、設定、および潜在的にユーザーロールを管理するためのAPIを提供します（許可レベルが存在する場合）。
• 認証： Ansopediaの機能とリソースへのアクセスを確保するために、堅牢な認証メカニズム（例えば、JWTトークン）を実装します。
• 統合： Ansopedia Studio APIのような他のサービスと協力して、コンテンツの作成とインタラクションのユーザー許可を管理します。

スクリプトを理解する

手順に飛び込む前に、 package.jsonのスクリプトを分解しましょう。JSONファイル：

• ビルド： JavaScriptへのTranspiles TypeScriptコード。
• DEV：ホットリロード用のNodemonで開発サーバーを起動します。
• LINT： ESLINTを使用してコードベースをリントします。
• LINT：修正： LINTエラーを自動的に修正します。
• 準備：ハスキー前のフックを実行します。
• 事前テスト：テストを実行する前にプロジェクトを構築します。
• きれい：チェック：コードフォーマットをチェックします。
• Prettier：修正：コードフォーマットを自動的に修正します。
• Prod： node_envを生産に設定し、プロジェクトを構築し、サーバーを起動します。
• 開始： TSノードを使用して開発サーバーを起動します。
• テスト：テストスイートを実行します。

開発環境

1. 依存関係をインストールします：

   pnpm install

2. 開発サーバーを開始：

   pnpm dev

   このコマンドはNodemonサーバーを起動します。これにより、TypeScriptファイルの変更が監視され、サーバーが自動的に再起動されます。

生産環境

1. 生産サーバーを開始します：

   pnpm prod

   このコマンドは、 NODE_ENV productionに設定し、プロジェクトを構築し、サーバーを起動します。

テスト環境

1. テストの実行：

   pnpm test

追加のスクリプト

• 糸くず：
  • コードスタイルの問題を確認してください： pnpm lint
  • コードスタイルの問題を自動的に修正： pnpm lint:fix
• フォーマット：
  • コードのフォーマットの問題を確認してください： pnpm prettier:check
  • コードのフォーマット問題を自動的に修正： pnpm prettier:fix

ライセンス

貢献することにより、お客様はプロジェクトのライセンスに基づいて貢献がライセンスされることに同意します。

貢献

Ansopedia Creator Studioへの貢献を歓迎します！詳細については、converting.mdをお読みください。

行動規範

コミュニティでの行動に対する期待を概説するcode_of_conduct.mdがあります。読んでください。

貢献者

Ansopedia Creator Studioへのすべての貢献者を歓迎し、表彰します。

セキュリティキーのセットアップ

JWTトークンの署名と検証の場合、このサービスにはRSAキーペアが必要です。

開発セットアップ

1. プロジェクトルートにkeysディレクトリを作成します
2. キー生成スクリプトを実行します。

npm run generate-keys

生産セットアップ

生産環境の場合、キーは次のとおりです。

• 安全にオフラインで生成されます
• 安全なキー管理サービスに保存されています
• コンテナ/環境の秘密として取り付けられています
• バージョンコントロールにコミットしませんでした

予想されるキーファイルは次のとおりです。

• /keys/private.pem -rsa秘密キー（安全に保つ！）
• /keys/public.pem -RSA公開キー（配布できます）