ya2ber

ya2ber

CLI discute pour discuter. Pas d'annonces, pas de collection de statistiques, pas de termes spéciaux, pas de services tiers inconnus, pas d'espaces, pas d'interfaces délicates ... pas de conneries.

---

Étymologie

Ya2ber est juste dérivé de Yabber , qui est le synonyme de Jabber , qui est le synonyme de la conférence habituelle.

Caractéristiques

• Authentification basée sur la connexion et le mot de passe.
• Montre combien de visiteurs sont dans le chat. Actuellement, ces informations sont affichées dans l'invite PS1.
• Les membres du chat sont informés lorsqu'une personne est partie.
• Il existe 3 catégories / types de messages - système (y compris ceux du serveur), l'authentification destinées et juste des messages de chat.
• Le client et le serveur utilisent JSON comme format de données pour transmettre des données les uns aux autres. Voyez comment.
• La saisie du mot de passe est cachée (comme de nombreuses autres applications CLI, y compris sudo ) et n'est pas stockée dans l'histoire.
• Les erreurs d'authentification sont bien reconnues en raison des messages d'erreur verbeux.
• Le client ne contient aucune logique de validation pour les informations d'identification de l'utilisateur, c'est la responsabilité d'un serveur.
• Le serveur stocke ces données utilisateur spécifiques: date d'enregistrement, dernière date d'activité et dernière adresse IP utilisée. ^*
• Le serveur ne stocke aucun historique de messages. Au lieu de cela, le client pourrait stocker l'historique localement en option.
• Prévention de la typosquat dans les noms d'utilisateur.
• REWAYS UI pour l'utilisation de la bibliothèque de malédictions bénies
• La bibliothèque Libsignal est utilisée pour le chiffrement de la communication

* En fait, le serveur stocke la dernière date de connexion plutôt que la dernière date d'activité pour l'instant

Options de CLI

Schéma de message JSON

Exemple du message du client:

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

Exemple du message du serveur:

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

Développement

Installation

Installation

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

cd ya2ber

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

Pré-engager

Nous utilisons le pré-engagement pour exécuter des vérifications de code localement, juste avant de s'engager, pour nous assurer que toutes les exigences et politiques de code de base étaient respectées. L'installation est assez simple (action unique):

 # 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

Maintenant, Pre-Commit fonctionnera automatiquement sur git commit ! La configuration pour les crochets pré-comiss est stockée dans le fichier .pre-commit-config.yaml .

Notes de pré-engagement

• Si vous souhaitez ignorer tous les contrôles de pré-engagement (non recommandés!), Vous pouvez ajouter le paramètre -n comme suit:

git commit -m " commit message " -n

• Alternativement, si vous souhaitez uniquement sauter une vérification spécifique, vous pouvez utiliser SKIP=<hook_id> avant la commande:

SKIP=codespell git commit -m " commit message " 

Stockage des secrets

Généralement, il peut être nécessaire d'utiliser certaines données sensibles, généralement stockées dans des variables d'environnement, dans l'application. Par exemple, AWS Keys. Si c'est le cas, il est important de se rappeler que toutes les données sensibles ne doivent pas être divulguées au public , y compris le référentiel GitHub.

Pour ce faire, créez un fichier .env.local (n'utilisez pas le fichier .env dans ce cas) dans le répertoire approprié (client / serveur /), et placez les variables d'environnement destinées à y être privées. Ce fichier est ignoré par GIT et exclu du contexte Docker sur la construction d'images.

Scripts d'automatisation

Nous utilisons GNU Make pour les opérations automatisées liées au code source et au déploiement des applications.

Disponible les commandes au niveau du projet

Obtenez de l'aide / guide pour toutes les commandes disponibles.

make

make help