Serviço de usuário da ANSOPEDIA
O Serviço de Usuário da Ansopedia é um serviço de back -end responsável pelo gerenciamento de contas de usuário e autenticação na plataforma de aprendizado da Ansopedia. Ele fornece funcionalidades como:
- Registro e login do usuário: permite que os usuários criem novas contas e efetuem login com segurança na plataforma.
- Gerenciamento de usuários: oferece APIs para gerenciar perfis de usuário, preferências e funções potencialmente do usuário (se houver níveis de permissão).
- Autenticação: implementa mecanismos de autenticação robustos (por exemplo, tokens JWT) para garantir o acesso aos recursos e recursos da Ansopedia.
- Integração: colabora com outros serviços, como a API do AnoPedia Studio, para gerenciar as permissões de usuário para criação e interação de conteúdo.
Compreendendo os scripts
Antes de mergulharmos nas etapas, vamos quebrar os scripts do seu arquivo package.json :
- Construir: transpilos o código TypeScript para JavaScript.
- Dev: inicia o servidor de desenvolvimento com o Nodemon para recarregar a quente.
- FIE: fiage a base de código usando ESLint.
- FIEL: Corrija: corrige automaticamente erros de fiapos.
- Prepare: executa ganchos de pré-compromisso Husky.
- Pré -teste: constrói o projeto antes de executar testes.
- mais bonito: verifique: verifica a formatação do código.
- mais bonito: corrige: corrige a formatação do código automaticamente.
- Prod: define o node_env para a produção, cria o projeto e inicia o servidor.
- Iniciar: inicia o servidor de desenvolvimento usando o nó TS.
- Teste: executa o conjunto de testes.
Ambiente de Desenvolvimento
Instale dependências:
Iniciar o servidor de desenvolvimento:
Este comando iniciará um servidor Nodemon, que observará as alterações nos seus arquivos de texto digital e reiniciará automaticamente o servidor.
Ambiente de produção
Inicie o servidor de produção:
Este comando define o NODE_ENV para production , cria o projeto e inicia o servidor.
Ambiente de teste
Executar testes:
Scripts adicionais
- LING:
- Verifique se há problemas de estilo de código:
pnpm lint - Corrija automaticamente problemas de estilo de código:
pnpm lint:fix
- Formatação:
- Verifique se há problemas de formatação de código:
pnpm prettier:check - Corrija automaticamente problemas de formatação de código:
pnpm prettier:fix
Licença
Ao contribuir, você concorda que suas contribuições serão licenciadas sob a licença do projeto.
Contribuindo
Congratulamo -nos com contribuições para o Ansopedia Creator Studio! Por favor, leia nosso contribuinte.md para obter mais detalhes.
Código de Conduta
Temos um code_of_conduct.md que descreve nossas expectativas de comportamento na comunidade. Por favor, leia.
Colaboradores
Congratulamo -nos com e reconhecemos todos os colaboradores do Ansopedia Creator Studio.
Configuração das chaves de segurança
Para assinatura e verificação de token JWT, este serviço requer pares de chave RSA.
Configuração de desenvolvimento
- Crie um diretório
keys na raiz do projeto - Execute o script de geração de chaves:
Configuração de produção
Para ambientes de produção, as chaves devem ser:
- Gerado com segurança offline
- Armazenado em um serviço de gerenciamento de chaves seguros
- Montado como segredos no recipiente/ambiente
- Nunca comprometido com o controle da versão
Os arquivos de chave esperados são:
-
/keys/private.pem - RSA Chave privada (mantenha seguro!) -
/keys/public.pem - RSA Public Key (pode ser distribuída)