user service

Ansopedia用户服务

Ansopedia用户服务是一项后端服务，负责管理Ansopedia学习平台内的用户帐户和身份验证。它提供了类似的功能：

• 用户注册和登录名：使用户能够创建新帐户并牢固地登录到平台。
• 用户管理：提供API来管理用户配置文件，偏好和潜在的用户角色（如果存在权限级别）。
• 身份验证：实现强大的身份验证机制（例如JWT代币），以确保访问Ansopedia功能和资源。
• 集成：与其他服务（例如Ansopedia Studio API）合作，以管理用户权限创建和交互。

了解脚本

在深入研究步骤之前，让我们分解您的package.json中的脚本。JSON文件：

• 构建：将打字稿代码转换为JavaScript。
• 开发人员：使用Nodemon启动开发服务器进行热重新加载。
• 棉绒：使用ESLINT将代码库覆盖。
• 棉绒：修复：自动修复皮棉错误。
• 准备：运行沙哑的预要钩子。
• 预测试：在进行测试之前建立项目。
• 漂亮：检查：检查代码格式。
• 漂亮：修复：修复代码格式化。
• 产品：将node_env设置为生产，构建项目并启动服务器。
• 开始：使用TS节点启动开发服务器。
• 测试：运行测试套件。

发展环境

1. 安装依赖项：

   pnpm install

2. 开始开发服务器：

   pnpm dev

   此命令将启动Nodemon服务器，该服务器将注意打字稿文件的更改，并自动重新启动服务器。

生产环境

1. 启动生产服务器：

   pnpm prod

   此命令将NODE_ENV设置为production ，构建项目并启动服务器。

测试环境

1. 运行测试：

   pnpm test

附加脚本

• 绒毛：
  • 检查代码样式问题： pnpm lint
  • 自动修复代码样式问题： pnpm lint:fix
• 格式：
  • 检查代码格式问题： pnpm prettier:check
  • 自动修复代码格式问题： pnpm prettier:fix

执照

通过贡献，您同意您的捐款将获得项目许可证的许可。

贡献

我们欢迎对Ansopedia Creator Studio的贡献！请阅读我们的贡献。md以获取更多详细信息。

行为守则

我们有一个code_of_conduct.md，概述了我们对社区行为的期望。请阅读。

贡献者

我们欢迎并认识到Ansopedia Creator Studio的所有贡献者。

安全密钥设置

对于JWT令牌签名和验证，此服务需要RSA键对。

开发设置

1. 在项目root中创建一个keys目录
2. 运行密钥生成脚本：

npm run generate-keys

生产设置

对于生产环境，密钥应为：

• 牢固地离线生成
• 存储在安全的密钥管理服务中
• 安装在容器/环境中的秘密
• 从未承诺进行版本控制

预期的关键文件是：

• /keys/private.pem RSA私钥（保持安全！）
• /keys/public.pem RSA公共密钥（可以分发）