Frontend часть проекта моджи, онлайн системы бронирования для отеля животных

🚀 Запуск Приложения

Чтобы запустить приложение на локальной машине, выполните следующие шаги:

1. Клонируйте репозиторий:

   git clone https://github.com/azawert/modji-frontend

2. Установите зависимости:

   npm install

3. Запустите приложение в режиме разработки:

   npm run dev

🛠 Используемый Стек Технологий

1. React: Библиотека для создания пользовательских интерфейсов.
2. TypeScript: Язык программирования, который добавляет статическую типизацию к JavaScript.
3. Orval: Инструмент для генерации сервисов и моделей данных с бэкенда.
4. react-hook-form: Библиотека для создания форм и валидации.
5. react-query: Для управления асинхронными запросами.
6. zustand: Простое решение для глобального состояния.
7. Material-UI: Библиотека компонентов для React.
8. Jest: Фреймворк для тестирования компонентов.
9. Husky: Инструмент для работы с Git хуками.
10. Commitlint: Для стандартизации формата коммитов

📥 Инструкция по Созданию Пул Реквестов

1. Обновите локальную ветку develop:

   git checkout develop
   git pull origin develop

2. Создайте новую ветку с соответствующим названием: Используйте префиксы: feature/, bugfix/, hotfix/, release/, docs/, ci/, refactor/.
3. Дайте осознанное название коммиту по следующей схеме:

   [type]: [description]
   

   Где type может быть одним из следующих: feat: Новая функция fix: Исправление ошибки docs: Документация chore: Обслуживание проекта style: Изменения в стиле (без изменения функциональности) refactor: Рефакторинг кода ci: Изменения в CI/CD конфигурации test: Добавление тестов revert: Откат изменений perf: Оптимизация производительности vercel: Изменения, связанные с Vercel
4. После создания коммита отправьте пул реквест на ветку develop.

Инструкция по созданию .env файла, который необходим для работы с переменными окружения

1. В корне проекта находится файл .env.example. Этот файл содержит список всех необходимых переменных окружения, которые должны быть настроены для корректной работы приложения.
2. Чтобы создать файл .env, выполните следующую команду в терминале. Она скопирует содержимое .env.example в новый файл .env:

   cp.env.example .env

3. После выполнения этой команды у вас появится файл .env, который нужно будет отредактировать и заполнить реальными значениями для каждой переменной окружения.
4. Обратите внимание, что .env файл не должен попадать в систему контроля версий (Git), так как он может содержать конфиденциальную информацию, такую как ключи API или пароли. Убедитесь, что в вашем .gitignore добавлен .env.