From bee8259ca87d125c81b35992b966874353f8464d Mon Sep 17 00:00:00 2001 From: Semen Katz Date: Sun, 21 Jan 2024 00:05:04 +0200 Subject: [PATCH] refactor: edit README --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f979ced..fd1a0b1 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,20 @@ -# GoodFood • [демо](https://goodfood.acceleratorpracticum.ru) +# GoodFood ![Status in progress](https://badgen.net/badge/status/in%20progress/yellow) ![good_food_frontend workflow](https://github.com/healthy-food-and-dietary-products/frontend/actions/workflows/good_food_frontend_workflow.yaml/badge.svg) ![](https://badgen.net/static/React/18/gray) ![](https://badgen.net/static/React%20Router/6/gray) ![](https://badgen.net/static/Vite/4/gray) ![screencast](https://media.giphy.com/media/v1.Y2lkPTc5MGI3NjExZTV5cDhleXQ0eDl4MTcxYXBzdWVmemV4ajR0b3J6YWY4YnNkaHNhdyZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/7hYj9hn0IngL6XATdL/giphy.gif) -Фронтенд платформы для онлайн-продажи и доставки здоровой пищи и диетических продуктов. React-приложение на TypeScript. +Платформа для продажи и доставки здоровой пищи и диетических продуктов онлайн. React-приложение на TypeScript. Демо проекта доступно здесь: [goodfood.acceleratorpracticum.ru](https://goodfood.acceleratorpracticum.ru) -## Цель и результат +## Цель -Мы хотели приобрести опыт командной разработки в условиях близких к реальным: создать продукт в кросс-функциональной команде; руководствоваться брифом и комментариями заказчика; строго соблюдать дедлайны. +Приобрести опыт командной разработки в условиях близких к реальным: создать продукт в кросс-функциональной команде; руководствоваться брифом и комментариями заказчика; строго соблюдать дедлайны. -Менеджментом был выделен этап работы над MVP и обозначен график дальнейших релизов. По итогам каждого спринта команда проходила код-ревью. Каждый релиз презентовался заказчику. +## Результат -Команде удалось выдержать график и на каждой презентации продемонстрировать работоспособное приложение. В процессе работы пришлось неоднократно пересматривать фич-лист, а также жертвовать качеством архитектурных решений и глубиной код-ревью. Все существующие проблемы приложения сохранялись в бэклоге и обозначены ниже в планах на будущее. +Команде удалось выдержать график и на каждой презентации продемонстрировать работоспособное приложение. Сначала был сдан MVP, и затем показано еще 2 релиза. Работа над проектом заняла 3 месяца. + +В процессе работы пришлось неоднократно пересматривать фич-лист, а также жертвовать качеством архитектурных решений и глубиной код-ревью. Все существующие проблемы приложения сохранены в бэклоге и обозначены ниже в планах на будущее. ## Фич-лист @@ -39,7 +41,7 @@ ## Планы на будущее -- Реорганизация структуры приложения. Отеделение бизнес-логики от UI. +- Реорганизация структуры приложения. Отделение бизнес-логики от UI. - Рефакторинг кода компонентов. Вынесение типов и констант, комментирование/документация интерфейсов компонентов и ключевых функций. - Рефакторинг стилей. Использование функционала SASS, вынесение ключевых значений в переменные, реорганизация селекторов вложенных компонентов и псевдоклассов. - Наполнение Story Book для дальнейшей работы с компонентами.