Ярмарка проектов ИРНИТУ

Клиентская часть проекта "Ярмарка проектов ИРНИТУ".

Стек технологий

• Vue 3
• TypeScript
• Vite
• Pinia
• Vue-Query

---

Требования для запуска

1. Git (CLI или GUI)
2. Node.js >= v16.17.0
   Проверить установленную версию Node.js можно с помощью команды:

   node -v

Инструкции по запуску

1. Клонирование репозитория
   • Склонируйте репозиторий проекта на ваш компьютер:

   git clone https://github.com/malinatrash/projfair-client

   • Перейдите в папку проекта

   cd projfair-client

2. Установка зависимостей
   • Установите необходимые зависимости:

   npm install

3. Настройка переменных окружения - Все URL-адреса для работы приложения по умолчанию определены в файле .env. Если этот файл отсутствует, создайте его в корне проекта и добавьте следующие строки:

VITE_BASE_URL=/
VITE_API_URL=http://62.109.5.123/
VITE_API_URL_LOCAL=http://localhost:8000/
VITE_MOCK_API=false
VITE_MOCK_AUTH=true

• VITE_BASE_URL: базовый URL для продакшн-сборки, например, /.
• VITE_API_URL: URL для тестового запуска в продакшн-режиме (например, для запросов к развернутому бэкенду).
• VITE_API_URL_LOCAL: URL для работы с локальным сервером.
• VITE_MOCK_API: флаг для использования мок-данных (если установлено false, используются реальные API).
• VITE_MOCK_AUTH: флаг для использования мок-авторизации.

4. Запуск проекта

   4.1. Запуск с локальным сервером (без режима prod)

   • Выполните команду:

   npm run dev

   При этом запросы будут отправляться на локальный сервер. Для работы необходимо развернуть бэкенд локально или через Docker. Инструкции по настройке локального сервера находятся в репозитории бэкенда: Репозиторий бэкенда

   После запуска проект будет доступен по адресу: http://localhost:3000/

   4.2. Запуск с мок-данными (локальные данные)

   • Если бэкенд недоступен, проект можно запустить с использованием мок-данных. Для этого выполните:

   npm run dev:mock

   Проект также будет доступен по адресу: http://localhost:3000/

   4.3. Запуск с продакшен сервером (режим prod)

   • Для подключения к бэкенду, развернутому на продакшен сервере, выполните:

   npm run dev:prod

   В режиме prod запросы будут отправляться на продакшен сервер. Убедитесь, что сервер настроен и доступен.

   Проект также будет доступен по адресу: http://localhost:3000/

Дополнительные команды

• Сборка проекта: npm run build
• Просмотр собранной версии: npm run serve
• Запуск тестов: npm run test:unit
• Проверка покрытия кода тестами: npm run test:coverage
• Линтинг и автоформатирование кода: npm run lint
• Проверка типизации: npm run type-check
• Развертывание на GitHub Pages: npm run deploy:gh-pages
• Запуск Storybook: npm run storybook
• Сборка Storybook: npm run build-storybook