user service

Servicio de usuario de Ansopedia

El Servicio de Usuario de Ansopedia es un servicio de back -end responsable de administrar cuentas de usuario y autenticación dentro de la plataforma de aprendizaje Ansopedia. Proporciona funcionalidades como:

• Registro e inicio de sesión del usuario: permite a los usuarios crear nuevas cuentas e iniciar sesión de forma segura en la plataforma.
• Gestión del usuario: ofrece API para administrar perfiles de usuario, preferencias y roles potencialmente de usuario (si existen niveles de permiso).
• Autenticación: implementa mecanismos de autenticación robustos (p. Ej., Tokens JWT) para asegurar el acceso a las características y recursos de la Ansopedia.
• Integración: colabora con otros servicios como Ansopedia Studio API para administrar los permisos de los usuarios para la creación e interacción de contenido.

Comprender los guiones

Antes de sumergirnos en los pasos, descompongamos los scripts en su archivo package.json :

• Build: Transpiles Código tipográfico a JavaScript.
• Dev: inicia el servidor de desarrollo con Nodemon para recarga en caliente.
• LNINT: Lints la base de código usando Eslint.
• Lint: Fix: corrige automáticamente los errores de pelusa.
• Preparar: ejecuta ganchos de pre-compromisos Husky.
• Prueba Prueba: construye el proyecto antes de ejecutar pruebas.
• más bonito: Verifique el formato de código de código.
• Pettier: corrige: corrige el formato de código automáticamente.
• Prod: Establece el node_env en producción, construye el proyecto e inicia el servidor.
• Inicio: inicia el servidor de desarrollo usando el nodo TS.
• Prueba: ejecuta la suite de prueba.

Entorno de desarrollo

1. Instalar dependencias:

   pnpm install

2. Iniciar servidor de desarrollo:

   pnpm dev

   Este comando iniciará un servidor Nodemon, que observará los cambios en sus archivos TypeScript y reiniciará automáticamente el servidor.

Entorno de producción

1. Inicie el servidor de producción:

   pnpm prod

   Este comando establece el NODE_ENV en production , construye el proyecto e inicia el servidor.

Entorno de prueba

1. Ejecutar pruebas:

   pnpm test

Scripts adicionales

• Pelusa:
  • Verifique los problemas de estilo de código: pnpm lint
  • Arreglar automáticamente los problemas de estilo de código: pnpm lint:fix
• Formato:
  • Verifique los problemas de formato del código: pnpm prettier:check
  • Arreglar automáticamente los problemas de formato de código: pnpm prettier:fix

Licencia

Al contribuir, usted acepta que sus contribuciones se licenciarán bajo la licencia del proyecto.

Que contribuye

¡Agradecemos contribuciones al Estudio de Creator de Ansopedia! Lea nuestro contribuyente.md para más detalles.

Código de conducta

Tenemos un código_of_conduct.md que describe nuestras expectativas de comportamiento en la comunidad. Por favor léelo.

Colaboradores

Agradecemos y reconocemos a todos los contribuyentes al Ansopedia Creator Studio.

Configuración de claves de seguridad

Para la firma y verificación del token JWT, este servicio requiere pares de claves RSA.

Configuración de desarrollo

1. Crear un directorio keys en la raíz del proyecto
2. Ejecute el script de generación de claves:

npm run generate-keys

Configuración de producción

Para los entornos de producción, las claves deben ser:

• Generado de forma segura fuera de línea
• Almacenado en un servicio seguro de gestión de claves
• Montado como secretos en el contenedor/entorno
• Nunca comprometido con el control de versiones

Los archivos clave esperados son:

• /keys/private.pem - RSA Private Key (¡manténgase seguro!)
• /keys/public.pem - RSA Public Key (se puede distribuir)