Layanan Pengguna Ansopedia
Layanan Pengguna Ansopedia adalah layanan backend yang bertanggung jawab untuk mengelola akun pengguna dan otentikasi dalam platform pembelajaran Ansopedia. Ini memberikan fungsionalitas seperti:
- Registrasi dan Login Pengguna: Memungkinkan pengguna untuk membuat akun baru dan masuk dengan aman ke platform.
- Manajemen Pengguna: Menawarkan API untuk mengelola profil pengguna, preferensi, dan peran pengguna yang berpotensi (jika ada tingkat izin).
- Otentikasi: Menerapkan mekanisme otentikasi yang kuat (misalnya, token JWT) untuk mengamankan akses ke fitur dan sumber daya Ansopedia.
- Integrasi: Berkolaborasi dengan layanan lain seperti Ansopedia Studio API untuk mengelola izin pengguna untuk pembuatan dan interaksi konten.
Memahami skrip
Sebelum kita menyelami langkah -langkahnya, mari kita uraikan skrip dalam file package.json Anda:
- Build: Transpiles Kode TypeScript ke JavaScript.
- Dev: Memulai server pengembangan dengan nodemon untuk memuat ulang panas.
- Lint: Lints CodeBase menggunakan Eslint.
- Lint: Fix: Secara otomatis memperbaiki kesalahan serat.
- Persiapkan: Menjalankan kait pra-komit husky.
- Pretest: Membangun proyek sebelum menjalankan tes.
- Prettier: Periksa: Periksa pemformatan kode.
- Prettier: Perbaiki: Memperbaiki pemformatan kode secara otomatis.
- Prod: Mengatur node_env ke produksi, membangun proyek, dan memulai server.
- Mulai: Mulai server pengembangan menggunakan TS-Node.
- Tes: Menjalankan test suite.
Lingkungan pengembangan
Instal dependensi:
Mulai Server Pengembangan:
Perintah ini akan memulai server Nodemon, yang akan menonton perubahan dalam file TypeScript Anda dan secara otomatis memulai kembali server.
Lingkungan produksi
Mulai server produksi:
Perintah ini mengatur NODE_ENV ke production , membangun proyek, dan memulai server.
Lingkungan Uji
Jalankan tes:
Skrip tambahan
- Linting:
- Periksa masalah gaya kode:
pnpm lint - Secara Otomatis Memperbaiki Masalah Gaya Kode:
pnpm lint:fix
- Memformat:
- Periksa masalah pemformatan kode:
pnpm prettier:check - Secara Otomatis Memperbaiki Masalah Pemformatan Kode:
pnpm prettier:fix
Lisensi
Dengan berkontribusi, Anda setuju bahwa kontribusi Anda akan dilisensikan di bawah lisensi proyek.
Berkontribusi
Kami menyambut kontribusi di Ansopedia Creator Studio! Harap baca contributing.md kami untuk lebih jelasnya.
Kode Etik
Kami memiliki code_of_conduct.md yang menguraikan harapan kami untuk perilaku di komunitas. Harap baca.
Kontributor
Kami menyambut dan mengenali semua kontributor di Ansopedia Creator Studio.
Pengaturan Kunci Keamanan
Untuk penandatanganan dan verifikasi token JWT, layanan ini membutuhkan pasangan kunci RSA.
Pengaturan Pembangunan
- Buat direktori
keys di root proyek - Jalankan skrip pembuatan kunci:
Pengaturan Produksi
Untuk lingkungan produksi, kunci harus:
- Dihasilkan secara offline dengan aman
- Disimpan dalam layanan manajemen kunci yang aman
- Dipasang sebagai rahasia di dalam wadah/lingkungan
- Tidak pernah berkomitmen untuk kontrol versi
File kunci yang diharapkan adalah:
-
/keys/private.pem - kunci pribadi RSA (tetap aman!) -
/keys/public.pem - RSA Public Key (dapat didistribusikan)