user service

Ansopedia 사용자 서비스

Ansopedia 사용자 서비스는 Ansopedia 학습 플랫폼 내에서 사용자 계정 및 인증을 관리하는 백엔드 서비스입니다. 다음과 같은 기능을 제공합니다.

• 사용자 등록 및 로그인 : 사용자가 새 계정을 만들고 플랫폼에 안전하게 로그인 할 수 있습니다.
• 사용자 관리 : API를 제공하여 사용자 프로파일, 기본 설정 및 잠재적으로 사용자 역할 (권한 수준이 존재하는 경우)을 관리합니다.
• 인증 : Ansopedia 기능 및 리소스에 대한 액세스를 보장하기 위해 강력한 인증 메커니즘 (예 : JWT 토큰)을 구현합니다.
• 통합 : Ansopedia Studio API와 같은 다른 서비스와 협력하여 콘텐츠 생성 및 상호 작용에 대한 사용자 권한을 관리합니다.

스크립트 이해

단계를 시작하기 전에 package.json 파일의 스크립트를 분해하겠습니다.

• 빌드 : Transpiles TypeScript 코드를 JavaScript로 transpiles.
• Dev : Hot Reloading을 위해 Nodemon으로 개발 서버를 시작합니다.
• LINT : ESLINT를 사용하여 코드베이스를 줄입니다.
• LINT : FIX : Lint 오류를 자동으로 수정합니다.
• 준비 : 허스키 사전 커밋 후크를 실행합니다.
• 사전 테스트 : 테스트를 실행하기 전에 프로젝트를 구축합니다.
• 더 예쁘다 : 점검 : 코드 서식을 확인합니다.
• 더 Prettier : Fix : 코드 서식을 자동으로 수정합니다.
• prod : node_env를 생산으로 설정하고 프로젝트를 구축하며 서버를 시작합니다.
• 시작 : ts-node를 사용하여 개발 서버를 시작합니다.
• 테스트 : 테스트 스위트를 실행합니다.

개발 환경

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에 대한 기여를 환영합니다! 자세한 내용은 Contributing.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 공개 키 (배포 가능)