README.md

Фронтенд проекта «Я Помогаю»

Описание

Проект для волонтерской организации ЯПомогаю. Цель, создать удобное веб-приложение поиска волонтёров для помощи реципиентам. От выгула собак, до помощи людям с ограниченными возможностями.

Бриф проекта

Макет в figma

Технологии

• NodeJS v18.15.0 (build)
• React v18.2
• TypeScript v4.9.5
• React Router v6.11.1
• Redux Toolkit 1.9.5
• RTK Query

Визуализация UI компонентов

• Storybook v8

Локальная разработка БЕЗ докера

Должен быть установлен NodeJS v18.15

1. Склонировать репозиторий фронтенда

   git clone [email protected]:ya-pomogau/frontend.git

2. Установить зависимости именно npm ci

   npm ci

3. Скопировать .env.development.example в .env.development - vite по такому имени будет искать файл с переменными окружения для локальной разработки

4. Запустить скрипт фронтенда и storybook в concurrent режиме

   npm run dev

5. Фронтенд доступен на PORT из .env.development (по умолчанию http://localhost:3000)

6. Storybook доступен на http://localhost:6007

Локальная разработка c докером

1. Склонировать репозиторий фронтенда

   git clone [email protected]:ya-pomogau/frontend.git

2. Скопировать .env.dev.example в .env.dev

3. Запустить контейнер фронта

   docker compose -f docker-compose.dev.yml --env-file=.env.dev up --build
   
   # или с помощью Makefile
   make run-dev

   Фронтенд по дефолту будет доступен на http://localhost:3000/