ya2ber

ya2ber

CLI Chat para chatear. Sin anuncios, sin colección de estadísticas, sin términos especiales, sin servicios de terceros desconocidos, sin espías, sin interfaces difíciles ... sin mierda.

---

Etimología

Ya2ber se deriva de Yabber , que es el sinónimo de Jabber , que es el sinónimo de charla habitual.

Características

• Autenticación basada en inicio de sesión y contraseña.
• Muestra cuántos visitantes hay en el chat. Actualmente, esta información se muestra en PS1 Avic.
• Se notifica a los miembros del chat cuando alguien se fue.
• Hay 3 categorías/tipos de mensajes: sistema (incluidos los del servidor), la autenticación propuesta y solo los mensajes de chat.
• El cliente y el servidor usan JSON como formato de datos para transmitir datos entre sí. Ver cómo.
• La entrada de contraseña está oculta (como lo hacen muchas otras aplicaciones CLI, incluido sudo ) y no se almacena en la historia.
• Los errores de autenticación están bien reconocidos debido a los mensajes de error detallados.
• El cliente no contiene ninguna lógica de validación para las credenciales del usuario, esta responsabilidad de un servidor.
• Tienda de servidor Tales datos de usuario específicos: fecha de registro, última fecha de actividad y última dirección IP utilizada. ^*
• El servidor no almacena ningún historial de mensajes. En cambio, el cliente podría almacenar el historial localmente como una opción.
• Prevención del tipo de escritura en los nombres de usuario.
• Reelaborar UI para usar biblioteca de maldiciones bendecidas
• Libsignal Library se utiliza para el cifrado de comunicación

* En realidad, las tiendas de servidor la última fecha de inicio de sesión en lugar de la última fecha de actividad por ahora

Opciones de CLI

Esquema de mensajes JSON

Ejemplo del mensaje del cliente:

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

Ejemplo del mensaje del servidor:

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

Desarrollo

Configuración

Instalación

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

cd ya2ber

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

Precomito

Utilizamos pre-Commit para ejecutar las verificaciones de código localmente, justo antes de comprometerse, para garantizar que se respeten todos los requisitos y políticas básicas del código. La instalación es bastante simple (acción ú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

¡Ahora el pre-Commit se ejecutará automáticamente en git commit ! La configuración para los ganchos previos al comercio se almacena en el archivo .pre-commit-config.yaml .

Notas previas a la contratación

• Si desea omitir todas las verificaciones previas al Commit (¡no se recomienda!), Puede agregar el parámetro -n de la siguiente manera:

git commit -m " commit message " -n

• Alternativamente, si solo desea omitir alguna verificación específica, puede usar SKIP=<hook_id> antes del comando:

SKIP=codespell git commit -m " commit message " 

Secretos de almacenamiento

En general, puede ser necesario usar algunos datos confidenciales, generalmente almacenados en variables de entorno, en la aplicación. Por ejemplo, AWS Keys. Si es así, es importante recordar que no se deben filtrar ningún datos confidenciales al público , incluido el repositorio de GitHub.

Para lograr esto, cree el archivo .env.local (no use el archivo .env en este caso) en el directorio apropiado (cliente/ servidor/), y coloque las variables de entorno destinadas a ser privadas allí. Este archivo es ignorado por Git y excluido del contexto de Docker en la compilación de imágenes.

Scripts de automatización

Utilizamos GNU Make for Automate Operations relacionadas con el código fuente y la implementación de la aplicación.

Disponible hacer comandos a nivel de proyecto

Obtenga ayuda/guía para todos los comandos disponibles.

make

make help