Skip to content

Commit

Permalink
Merge pull request #325 from healthy-food-and-dietary-products/develop
Browse files Browse the repository at this point in the history
Develop
  • Loading branch information
jsapro committed Jan 21, 2024
2 parents 7465ce4 + 1b7565d commit 7b45bd2
Showing 1 changed file with 70 additions and 3 deletions.
73 changes: 70 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,74 @@
# GoodFood

# Платформа для онлайн-продажи и доставки здоровой пищи и диетических продуктов
![Static Badge](https://img.shields.io/badge/status-in_progress-yellow) ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/healthy-food-and-dietary-products/frontend/good_food_frontend_workflow.yaml?logo=github) ![Static Badge](https://img.shields.io/badge/TypeScript-gray?logo=TypeScript) ![Static Badge](https://img.shields.io/badge/React-gray?logo=React) ![Static Badge](https://img.shields.io/badge/SASS-gray?logo=SASS)

![good_food_frontend workflow](https://github.com/healthy-food-and-dietary-products/frontend/actions/workflows/good_food_frontend_workflow.yaml/badge.svg)
![Screen cast](https://media.giphy.com/media/v1.Y2lkPTc5MGI3NjExZTV5cDhleXQ0eDl4MTcxYXBzdWVmemV4ajR0b3J6YWY4YnNkaHNhdyZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/7hYj9hn0IngL6XATdL/giphy.gif)

### Подробная информация по работе с проектом в файле `CONTRIBUTE.MD`
Платформа для продажи и доставки здоровой пищи и диетических продуктов онлайн. React-приложение на TypeScript. Демо проекта доступно здесь: [goodfood.acceleratorpracticum.ru](https://goodfood.acceleratorpracticum.ru)

## Цель

Приобрести опыт командной разработки в условиях близких к реальным: создать продукт в кросс-функциональной команде; руководствоваться брифом и комментариями заказчика; строго соблюдать дедлайны.

## Результат

Команде удалось выдержать график и на каждой презентации продемонстрировать работоспособное приложение. Сначала был сдан MVP, и затем показано еще 2 релиза. Работа над проектом заняла 3 месяца.

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

## Фич-лист

- [x] Главная страница (хедер, меню, футер)
- [x] Блок слайдера
- [x] Блок "Лидеры продаж"
- [x] Страница "О компании"
- [x] Страница "Рецепты"
- [x] Каталог товаров (с разными категориями)
- [x] Карточка товара
- [x] Функционал поиска и фильтрации
- [x] Регистрация и авторизация пользователя
- [x] Личный кабинет пользователя (с возможностью сменить данные пользователя)
- [x] Избранные товары
- [x] История заказов
- [x] Корзина
- [x] Функционал добавления продуктов из рецепта в корзину
- [x] Оформление заказа (с возможностью выбора вариантов доставки и оплаты)
- [x] Онлайн-оплата заказа
- [x] Рейтинг товаров
- [x] Отзывы пользователей
- [x] Применение промокодов при оформлении заказа
- [x] Мобильная версия

## Планы на будущее

- Реорганизация структуры приложения. Отделение бизнес-логики от UI.
- Рефакторинг кода компонентов. Вынесение типов и констант, комментирование/документация интерфейсов компонентов и ключевых функций.
- Рефакторинг стилей. Использование функционала SASS, вынесение ключевых значений в переменные, реорганизация селекторов вложенных компонентов и псевдоклассов.
- Наполнение Story Book для дальнейшей работы с компонентами.
- Подключение новых сервисов оплаты.
- Использование библиотек для работы с формами и валидации полей (React Hook Form, Zod/Yup).
- Исправление багов.

## Запуск

```bash
## После клонирования репозитория необходимо установить зависимости.
## Для надежной работы рекомендуем clean install:
npm ci

## Для запуска сборщика Vite в режиме разработки:
npm run dev
```

Подробная информация по работе с проектом в файле `CONTRIBUTE.MD`

## Ссылки

- [Демо](https://goodfood.acceleratorpracticum.ru)
- [Макеты (figma)](https://www.figma.com/file/AQCSX3HGPVThk3lmZEhF3o/%D0%9C%D0%B0%D0%B3%D0%B0%D0%B7%D0%B8%D0%BD-%D0%B7%D0%B4%D0%BE%D1%80%D0%BE%D0%B2%D0%BE%D0%B9-%D0%B8-%D0%B4%D0%B8%D0%B5%D1%82%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%BE%D0%B9-%D0%B5%D0%B4%D1%8B)
- [Спецификации и требования (google doc)](https://docs.google.com/document/d/14wuGhcx2ZiCdd9zaOkRaPifwISg_0vUFeAk59DmO7l0/edit#heading=h.retjyf7u653y)

## Команда

[Цуканов Семён](https://github.com/Simon062), [Бадалян Карина](https://github.com/KarinaSiamanta),
[Егорова Дарья](https://github.com/dar1aeg), [Шушкова Елена](https://github.com/Hellena60), [Ильина Дарья](https://github.com/DariaIlinaUX), [Данилович Алексей](https://github.com/jsapro), [Ивашова Мария](https://github.com/mmariaiv), [Харлаков Виталий](https://github.com/vkharlakov), [Владислав Потылицын](https://github.com/maik791277), [Егор Колесников](https://github.com/egor-kolesnikov), [Никишин Андрей](https://github.com/nocTKpunTyM), [Кармышков Евгений](https://github.com/Karmyshkov), [Семён Кац](https://github.com/kavabunga), [Волкова Галина](https://github.com/earlinn), [Говорливых Артём](https://github.com/govorlivyh), [Борискин Иван](https://github.com/ivan18258), [Стрельникова Юлиана](https://github.com/juliana-str), [Бобков Константин](https://github.com/deltabobkov), [Шарапов Вячеслав](https://github.com/Slava-prog), [Андреев Павел](https://github.com/andre-vpn), [Калягин Алексей](https://github.com/Alexey0081), [Стераспольская Елена](https://github.com/ElenaSter), [Лиукконен Светлана](https://github.com/nesusveta), [Токарева Наталья](https://github.com/Solotona), [Дорошенко Иван](https://github.com/dorosh1337), [Крупенникова Ольга](https://github.com/HelgaOO), [Манасян Халгина](https://github.com/Xalgina), [Бугураев Никита](https://github.com/ExTapeS)

0 comments on commit 7b45bd2

Please sign in to comment.