X-CONNECT-CHAT

Клиентское приложение (SPA) чат. Проект разработан исключительно для примера моего кода.

Приступая к работе

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

Необходимое программное обеспечение

• Node версии 12 и выше
• npm версии 6 и выше

Установка

Выполните следующую команду —

npm i

Запуск в режиме разработки

Для локальной разработки выполните следующую команду —

npm run start

Дев-сервер будет запущен на порту 3000. Обратите внимание, что обращение к API проксируется. Используемые прокси описаны в файле src/setupProxy.js, переменные окружения с адресами — в файле .env.development.

Сборка

Для сборки введите выполните следующую команду —

npm run build

Переменные окружения

• API_URL — адрес хоста для обращения к API сервера чата (например, http://example-host.ru/) с обязательным слеш (/) в конце
• WS_URL — адрес хоста для подключения WS соединения (например, ws://example-ws.ru/) с обязательным слеш (/) в конце

Распространение (Docker)

Возможна сборка и использование Docker-контейнера. Для запуска контейнера задайте все необходимые переменные окружения. Приложение в контейнере запускается на порту 27182. Пример запуска —

docker run --rm -d\
 -e API_URL=http://example-host.ru/\
 -e WS_URL=ws://example-ws.ru/\
 -p 8080:27182 docker-x-connected-chat.ru

Используемые технологии

• React - Фреймворк
• Typescript - Типизация
• Create react App - Темплейт для создания приложения
• Redux Toolkit - Работа с данными
• Material-UI - Библиотека с UI-компонентами

Версионирование

Используется SemVer. Для задания версии можно иcпользовать команду npm version patch.