บริการผู้ใช้ Ansopedia
บริการผู้ใช้ ANSOPEDIA เป็นบริการแบ็กเอนด์ที่รับผิดชอบในการจัดการบัญชีผู้ใช้และการรับรองความถูกต้องภายในแพลตฟอร์มการเรียนรู้ Ansopedia ให้ฟังก์ชันการทำงานเช่น:
- การลงทะเบียนผู้ใช้และเข้าสู่ระบบ: ช่วยให้ผู้ใช้สามารถสร้างบัญชีใหม่และเข้าสู่แพลตฟอร์มได้อย่างปลอดภัย
- การจัดการผู้ใช้: เสนอ APIs เพื่อจัดการโปรไฟล์ผู้ใช้การตั้งค่าและบทบาทของผู้ใช้ที่อาจเกิดขึ้น (หากมีระดับการอนุญาต)
- การรับรองความถูกต้อง: ใช้กลไกการตรวจสอบความถูกต้องที่แข็งแกร่ง (เช่นโทเค็น JWT) เพื่อรักษาความปลอดภัยการเข้าถึงคุณสมบัติและทรัพยากร Ansopedia
- การรวม: ร่วมมือกับบริการอื่น ๆ เช่น Ansopedia Studio API เพื่อจัดการสิทธิ์ของผู้ใช้สำหรับการสร้างเนื้อหาและการโต้ตอบ
ทำความเข้าใจสคริปต์
ก่อนที่เราจะดำดิ่งลงไปในขั้นตอนต่างๆให้แยกสคริปต์ลงในไฟล์ package.json ของคุณ:
- Build: TransPiles TypeScript Code เป็น JavaScript
- Dev: เริ่มต้นเซิร์ฟเวอร์การพัฒนาด้วย Nodemon สำหรับการโหลดซ้ำ
- ผ้าสำลี: ผ้าสำลี codebase โดยใช้ ESLINT
- ผ้าสำลี: แก้ไข: แก้ไขข้อผิดพลาดผ้าสำลีโดยอัตโนมัติ
- เตรียม: รันตะขอล่วงหน้าฮัสกี้
- Pretest: สร้างโครงการก่อนที่จะทำการทดสอบ
- Prettier: ตรวจสอบ: ตรวจสอบการจัดรูปแบบรหัส
- Prettier: แก้ไข: แก้ไขการจัดรูปแบบรหัสโดยอัตโนมัติ
- Prod: ตั้งค่า NODE_ENV เป็นการผลิตสร้างโครงการและเริ่มเซิร์ฟเวอร์
- เริ่มต้น: เริ่มต้นเซิร์ฟเวอร์การพัฒนาโดยใช้ TS-Node
- การทดสอบ: เรียกใช้ชุดทดสอบ
สภาพแวดล้อมการพัฒนา
ติดตั้งการพึ่งพา:
เริ่มการพัฒนาเซิร์ฟเวอร์:
คำสั่งนี้จะเริ่มต้นเซิร์ฟเวอร์ Nodemon ซึ่งจะดูการเปลี่ยนแปลงในไฟล์ typeScript ของคุณและรีสตาร์ทเซิร์ฟเวอร์โดยอัตโนมัติ
สภาพแวดล้อมการผลิต
เริ่มต้นเซิร์ฟเวอร์การผลิต:
คำสั่งนี้ตั้งค่า NODE_ENV เป็นการ production สร้างโครงการและเริ่มเซิร์ฟเวอร์
สภาพแวดล้อมการทดสอบ
เรียกใช้การทดสอบ:
สคริปต์เพิ่มเติม
- ผ้าสำลี:
- ตรวจสอบปัญหาสไตล์รหัส:
pnpm lint - แก้ไขปัญหาสไตล์รหัสโดยอัตโนมัติ:
pnpm lint:fix
- การจัดรูปแบบ:
- ตรวจสอบปัญหาการจัดรูปแบบรหัส:
pnpm prettier:check - แก้ไขปัญหาการจัดรูปแบบรหัสโดยอัตโนมัติ:
pnpm prettier:fix
ใบอนุญาต
โดยการบริจาคคุณยอมรับว่าการบริจาคของคุณจะได้รับใบอนุญาตภายใต้ใบอนุญาตของโครงการ
การบริจาค
เรายินดีต้อนรับการมีส่วนร่วมในสตูดิโอ Ansopedia Creator! โปรดอ่านรายละเอียดเพิ่มเติม
จรรยาบรรณ
เรามี code_of_conduct.md ที่สรุปความคาดหวังของเราสำหรับพฤติกรรมในชุมชน โปรดอ่าน
ผู้มีส่วนร่วม
เรายินดีต้อนรับและรับรู้ผู้มีส่วนร่วมทั้งหมดไปยังสตูดิโอ Ansopedia Creator
การตั้งค่าปุ่มรักษาความปลอดภัย
สำหรับการลงนามและการตรวจสอบโทเค็น JWT บริการนี้ต้องใช้คู่คีย์ RSA
การตั้งค่าการพัฒนา
- สร้างไดเรกทอรี
keys ในรูทโครงการ - เรียกใช้สคริปต์การสร้างคีย์:
การตั้งค่าการผลิต
สำหรับสภาพแวดล้อมการผลิตคีย์ควรเป็น:
- สร้างออฟไลน์อย่างปลอดภัย
- เก็บไว้ในบริการการจัดการคีย์ที่ปลอดภัย
- ติดตั้งเป็นความลับในภาชนะ/สิ่งแวดล้อม
- ไม่เคยมุ่งมั่นที่จะควบคุมเวอร์ชัน
ไฟล์คีย์ที่คาดหวังคือ:
-
/keys/private.pem - คีย์ส่วนตัว RSA (รักษาความปลอดภัย!) -
/keys/public.pem - คีย์สาธารณะ RSA (สามารถแจกจ่ายได้)