ya2ber

Ya2ber

CLI Catch, чтобы просто поболтать. Нет рекламы, нет статистических сборов, нет особых терминов, нет неизвестных сторонних услуг, без шпионов, никаких сложных интерфейсов ... без чушьты.

---

Этимология

Ya2ber только что получен из Yabber , который является синонимом Jabber , который является синонимом обычного разговора .

Функции

• Аутентификация на основе входа и пароля.
• Показывает, сколько посетителей в чате. В настоящее время эта информация отображается в подсказке PS1.
• Члены чата уведомляются, когда кто -то ушел.
• Существует 3 категории/типы сообщений - система (в том числе с сервера), целенаправленная аутентификация и просто сообщения чата.
• Клиент и сервер используют JSON в качестве формата данных для передачи данных друг другу. Посмотрите, как.
• Введение пароля скрыто (как и многие другие приложения CLI, включая sudo ) и не хранятся в истории.
• Ошибки аутентификации хорошо распознаются из -за словесных сообщений об ошибках.
• Клиент не содержит никакой логики проверки для учетных данных пользователя, это ответственность сервера.
• Сервер хранит такие конкретные пользовательские данные: дата регистрации, дата последней активности и последний используемый IP -адрес. ^*
• Сервер не хранит историю сообщений. Вместо этого клиент может хранить историю локально в качестве варианта.
• Профилактика опечатки в именах пользователей.
• Поврежден пользовательский интерфейс для использования блаженной библиотеки, подобной проклятиям
• Либеральная библиотека используется для шифрования связи

* На самом деле, сервер хранит последнюю дату входа в систему, а не дата последней активности

CLI варианты

JSON Message Schema

Пример сообщения клиента:

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

Пример сообщения сервера:

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

Разработка

Настраивать

Установка

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

cd ya2ber

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

Предварительная коммитация

Мы используем Pre-Commit для выполнения проверки кода локально, непосредственно перед обязательством, чтобы обеспечить соблюдение всех основных требований и политик кода. Установка довольно проста (одноразовое действие):

 # 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

Теперь Pre-Commit будет работать автоматически на git commit ! Конфигурация для предварительных крючков хранится в файле .pre-commit-config.yaml .

Предварительные примечания

• Если вы хотите пропустить все проверки предварительной коммиты (не рекомендуется!), Вы можете добавить параметр -n следующим образом:

git commit -m " commit message " -n

• В качестве альтернативы, если вы хотите пропустить какую -то конкретную проверку, вы можете использовать SKIP=<hook_id> перед командой:

SKIP=codespell git commit -m " commit message " 

Хранение секретов

Как правило, может потребоваться использование некоторых конфиденциальных данных, обычно хранящихся в переменных окружающей среды, в приложении. Например, ключи AWS. Если это так, важно помнить, что любые конфиденциальные данные не должны просоваться общественности , включая репозиторий GitHub.

Для этого создайте файл .env.local (не используйте файл .env в этом случае) в соответствующем каталоге (клиент/ или сервер/) и поместите переменные среды, предназначенные для того, чтобы быть частными. Этот файл игнорируется GIT и исключается из контекста Docker по сборке изображения.

Сценарии автоматизации

Мы используем GNU для автоматизации операций, связанных с исходным кодом и развертыванием приложений.

Доступные команды на уровне проекта

Получить помощь/руководство для всех доступных команд.

make

make help