ya2ber

ya2ber

Cli Chat, nur um zu chatten. Keine Anzeigen, keine statistische Sammlung, keine besonderen Begriffe, keine unbekannten Dienste von Drittanbietern, keine Spione, keine kniffligen Schnittstellen ... kein Bullshit.

---

Etymologie

Ya2ber ist nur von Yabber abgeleitet, dem Synonym für Jabber , das Synonym für übliche Gespräche .

Merkmale

• Authentifizierung basierend auf Login und Passwort.
• Zeigt, wie viele Besucher im Chat sind. Derzeit werden diese Informationen in der PS1 -Eingabeaufforderung angezeigt.
• Chat -Mitglieder werden benachrichtigt, wenn jemand gegangen ist.
• Es gibt 3 Nachrichtenkategorien/-typen - System (einschließlich derjenigen vom Server), Authentifizierungsziele und nur Chat -Nachrichten.
• Client und Server verwenden JSON als Datenformat für die Übertragung von Daten miteinander. Sehen Sie wie.
• Die Eingabe des Passworts ist versteckt (wie viele andere CLI -Anwendungen, einschließlich sudo ) und nicht in der Geschichte gespeichert.
• Authentifizierungsfehler werden aufgrund von ausführlichen Fehlermeldungen gut erkannt.
• Der Client enthält keine Validierungslogik für Benutzeranmeldeinformationen, dies für die Verantwortung eines Servers.
• Server speichert solche spezifischen Benutzerdaten: Registrierungsdatum, Datum des letzten Aktivität und zuletzt verwendete IP -Adresse. ^*
• Server speichert keinen Nachrichtenverlauf . Stattdessen könnte der Client die Geschichte vor Ort als Option speichern.
• Verhinderung von Tippfehler in Benutzernamen.
• Überarbeiten Sie die Benutzeroberfläche für die Verwendung gesegneter Flüche-ähnliche Bibliothek
• LibSsignal Library wird zur Kommunikationsverschlüsselung verwendet

* Tatsächlich speichert der Serverspeicher das letzte Anmeldedatum und nicht das letzte Aktivitätsdatum vorerst

CLI -Optionen

JSON -Nachrichtenschema

Beispiel für die Nachricht des Kunden:

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

Beispiel für die Nachricht des Servers:

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

Entwicklung

Aufstellen

Installation

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

cd ya2ber

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

Vorvermittlung

Wir verwenden das Vorverfahren zum Ausführen von Codeprüfungen kurz vor der Verpflichtung vor Ort, um sicherzustellen, dass alle grundlegenden Codeanforderungen und -richtlinien respektiert wurden. Die Installation ist ziemlich einfach (einmalige Aktion):

 # 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

Jetzt wird Pre-Commit automatisch im git commit ausführen! Die Konfiguration für Pre-Commit-Hooks wird in .pre-commit-config.yaml Datei gespeichert.

Vor-Commit-Notizen

• Wenn Sie alle Überprüfungen vor dem Kommunikation überspringen möchten (nicht empfohlen!), Sie können den Parameter -n wie folgt hinzufügen:

git commit -m " commit message " -n

• Alternativ, wenn Sie nur eine bestimmte Prüfung überspringen möchten, können Sie vor dem Befehl SKIP=<hook_id> verwenden:

SKIP=codespell git commit -m " commit message " 

Geheimnisse speichern

Im Allgemeinen kann es erforderlich sein, einige sensible Daten, die normalerweise in Umgebungsvariablen gespeichert sind, in Anwendung zu verwenden. Zum Beispiel AWS -Schlüssel. In diesem Fall ist es wichtig, sich daran zu erinnern, dass sensible Daten nicht der Öffentlichkeit, einschließlich Github -Repository, weitergeleitet werden sollten .

Um dies zu erreichen, erstellen Sie .Env.local -Datei (in diesem Fall nicht .Env -Datei verwenden) im entsprechenden Verzeichnis (Client/ oder Server/) und setzen Sie Umgebungsvariablen, die dort privat sein sollen. Diese Datei wird von Git ignoriert und vom Docker -Kontext im Bildbau ausgeschlossen.

Automatisierungsskripte

Wir verwenden GNU, um Operationen im Zusammenhang mit Quellcode und Anwendungsbereitstellung zu automatisieren.

Verfügbare Befehle auf Projektebene machen

Holen Sie sich Hilfe/Handbuch für alle verfügbaren Befehle.

make

make help