ya2ber

ya2ber

CLI bate -papo para apenas conversar. Sem anúncios, sem coleta de estatísticas, sem termos especiais, sem serviços de terceiros desconhecidos, sem espiões, sem interfaces complicadas ... sem besteira.

---

Etimologia

Ya2ber é derivado de Yabber , que é o sinônimo de Jabber , que é o sinônimo de conversa usual.

Características

• Autenticação com base no login e senha.
• Mostra quantos visitantes estão no bate -papo. Atualmente, essas informações são mostradas no prompt do PS1.
• Os membros do bate -papo são notificados quando alguém foi embora.
• Existem 3 categorias/tipos de mensagens - sistema (incluindo o servidor), autenticação proposta e apenas mensagens de bate -papo.
• Cliente e servidor usam o JSON como formato de dados para transmitir dados entre si. Veja como.
• A entrada de senha está oculta (como muitos outros aplicativos da CLI, incluindo sudo ) e não é armazenada na história.
• Os erros de autenticação são bem reconhecidos devido a mensagens de erro detalhadas.
• O cliente não contém nenhuma lógica de validação para as credenciais do usuário, essa responsabilidade de um servidor.
• O servidor armazena esses dados específicos do usuário: data de registro, data da última atividade e endereço IP usado pela última vez. ^*
• O servidor não armazena nenhum histórico de mensagens. Em vez disso, o cliente pode armazenar o histórico localmente como uma opção.
• Prevenção de digitação em nomes de usuário.
• Rework a interface do usuário para usar biblioteca abençoada de maldições
• A biblioteca libsignal é usada para criptografia de comunicação

* Na verdade, o servidor armazena a última data de login em vez da última data da atividade por enquanto

Opções da CLI

Esquema de mensagens JSON

Exemplo da mensagem do cliente:

{
    "message" : " Hello, username! " ,
    "type" : " message " ,
    "command" : " /username "
}

Exemplo da mensagem do servidor:

{
    "message" : " username left the chat " ,
    "type" : " system " ,
    "online" : 5
}

Desenvolvimento

Configurar

Instalação

git clone [email protected]:zhibirc/ya2ber.git

cd ya2ber

# it'll automatically install dependencies in all nested application folders
npm install

Pré-compromisso

Utilizamos o pré-compromisso para executar verificações de código localmente, pouco antes de cometer, para garantir que todos os requisitos e políticas básicos do código fossem respeitados. A instalação é bastante simples (ação única):

 # install pre-commit using Python's pip
pip install pre-commit
# OR
# install pre-commit using using Homebrew
brew install pre-commit

# install the Git hook scripts
pre-commit install

Agora, o pré-compromisso será executado automaticamente no git commit ! A configuração para ganchos de pré-compromisso é armazenada no arquivo .pre-commit-config.yaml .

Notas pré-comprometidas

• Se você deseja pular todas as verificações pré -comprometidas (não recomendadas!), Você pode adicionar o parâmetro -n da seguinte maneira:

git commit -m " commit message " -n

• Como alternativa, se você quiser pular apenas uma verificação específica, poderá usar SKIP=<hook_id> antes do comando:

SKIP=codespell git commit -m " commit message " 

Armazenamento de segredos

Geralmente, pode ser necessário usar alguns dados confidenciais, geralmente armazenados em variáveis ​​de ambiente, em aplicação. Por exemplo, as chaves da AWS. Nesse caso, é importante lembrar que quaisquer dados confidenciais não devem ser vazados ao público , incluindo o repositório do GitHub.

Para conseguir isso, crie um arquivo .env.local (não use o arquivo .env neste caso) no diretório apropriado (cliente/ ou servidor/) e coloque as variáveis ​​de ambiente destinadas a ser privadas lá. Este arquivo é ignorado pelo Git e excluído do contexto do Docker na construção da imagem.

Scripts de automação

Utilizamos o GNU cria para automatizar operações relacionadas ao código -fonte e à implantação de aplicativos.

Disponível faça comandos no nível do projeto

Obtenha ajuda/guia para todos os comandos disponíveis.

make

make help