NatterNet

Natternet

Ваше приложение в чате в реальном времени, построенное с Golang, MongoDB, WebSockets и FASTHTTP.

Оглавление

1. Введение
2. Функции
3. Ресурсы и сообщество
4. Документация API
5. Сообщения в блоге
6. Лицензия

Введение

Natternet - это быстрый и легкий сервис чата, созданный с Golang, MongoDB, WebSockets и FaTTTTP. Он направлен на предоставление масштабируемой и эффективной платформы для приложений в чате в реальном времени.

Функции

Завершенные функции

• Аутентификация пользователя

  • Аутентификация на основе JWT.
  • Ключи RSA для подписания JWT.

• Общение в реальном времени

  • Поддержка WebSocket для обновлений в реальном времени.
  • В реальном времени отображение статуса в реальном времени.

• Номера

  • Создать, присоединиться и оставить комнаты.

• Типы сообщений

  • Поддержка текстовых сообщений.

• Распределенные системы

  • NATS-потоковая передача для архитектуры, управляемой событиями.

• Регистрация

  • Комплексное ведение журнала с помощью Zap's Logger.

• API и веб -сервер

  • API, построенный на вершине волокна (FATTHTTP).

• База данных

  • MongoDB для постоянного хранения.

Предстоящие функции

• Поддержка дополнительных типов сообщений, таких как изображения, аудио, видео и т. Д.
• Push -уведомления через Firebase/OneSignal.
• Система присутствия пользователя.
• Редактирование и удаление сообщений.
• Многоязычная поддержка.
• Ограничение ставок для запросов API.

Ресурсы и сообщество

Мы составили список ресурсов, которые помогут вам понять, использовать и внести свой вклад в Natternet более эффективно:

• Команда почтальона : Присоединяйтесь к нашей команде почтальона, чтобы исследовать API Natternet's API.

• Общественный чат : Есть вопросы, обратная связь или просто хотите пообщаться? Присоединяйтесь к нашему серверу Discord.

• Вики : для подробных руководств, часто задаваемых вопросов и другой информации, ознакомьтесь с Wiki Natternet.

• Сообщения в блоге : глубокие погружения в архитектуру, доменную дизайн и другие аспекты Natternet доступны в нашем блоге Supack.

Не стесняйтесь вносить свой вклад, отправляя PRS, открывая проблемы или распространяя слово.

Документация API с Swagger

Вы можете получить доступ к документации API через Swagger в следующей конечной точке после начала приложения:

http: // localhost: 8080/api/v1/swagger/

СОВЕТ: Прежде чем углубляться в документацию, убедитесь, что выполнять make swagger в корне проекта. Этот шаг восстанавливает необходимые компоненты Swagger, поддерживая обновления документов.

Сообщения в блоге для более глубокого понимания

Хотите получить более глубокую информацию о Natternet? Проверьте наши сообщения в блоге:

1. Представление Natternet: приложение в реальном времени, управляемое доменом

   • Введение в Natternet и ее архитектура.

2. Natternet: глубокое погружение в чистую архитектуру

   • Узнайте детали того, как чистая архитектура реализована в Natternet.

3. Глубокое погружение в доменную дизайн в Natternet

   • Поймите нюансы дизайна, управляемого доменом, применяется в Natternet.

Лицензия

Natternet лицензирован по лицензии MIT. Смотрите файл лицензии для получения более подробной информации.