Skip to content

Commit 2177a7f

Browse files
committed
[PRAC/ret] Correct README.md file
Adding "new" functional, structural description for this proj (what/how). Worth noting: - that this is a realization of the "Skillbus-CRM" app. core: B-3 / JS-BL
1 parent 0f1a776 commit 2177a7f

File tree

2 files changed

+28
-15
lines changed

2 files changed

+28
-15
lines changed

core-courses/3-js-basic-level/practicum-js-basic-level/README.md

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,29 @@
22

33
### Описание проекта
44

5-
Данный проект представляет собой веб-приложение CRM для управления клиентами. Система позволяет добавлять, редактировать, удалять клиентов, а также управлять их контактными данными. Вся информация хранится на сервере, а клиентская часть динамически обновляется.
5+
Данный проект представляет собой веб-приложение CRM для управления клиентами. Система позволяет добавлять, редактировать, удалять клиентов, а также управлять их контактными данными. Вся информация хранится на удалённом сервере (изначально на локальном), что обеспечивает доступ к данным из любой точки с интернет-подключением. Клиентская часть динамически обновляется, используя асинхронные запросы к серверу.
6+
7+
[🔗 Демо-версия на GitHub Pages](https://matowdev.github.io/fullstack-js-by-skillbox/core-courses/3-js-basic-level/practicum-js-basic-level/sb-crm-client/)
68

79
---
810

911
### Функциональность
1012

11-
- Добавление клиентов (с динамическим управлением контактными данными).
12-
- Редактирование информации о клиентах (с обновлением данных в реальном времени).
13-
- Удаление клиентов (с подтверждением).
14-
- Использование модальных окон для управления клиентами (для добавления, редактирования и удаления).
15-
- Валидация введённых данных (с учетом типов контактов).
16-
- Сортировка клиентов и фильтрация по ФИО.
17-
- Поддержка интерактивных тултипов (для отображения информации).
13+
- **Добавление клиентов** (с динамическим управлением контактными данными).
14+
- **Редактирование информации о клиентах** (с обновлением данных в реальном времени).
15+
- **Удаление клиентов** (с подтверждением).
16+
- **Использование модальных окон для управления клиентами** (добавление, редактирование, удаление).
17+
- **Валидация введённых данных** (с учётом типов контактов).
18+
- **Сортировка клиентов и фильтрация по ФИО**.
19+
- **Поддержка интерактивных тултипов** (для отображения информации).
20+
- **Автоматическая подгрузка данных с удалённого сервера**.
21+
- **Индикация загрузки данных** (спиннер при ожидании ответа сервера).
22+
23+
---
24+
25+
### Внешний вид приложения
26+
27+
![Skillbus-CRM]()
1828

1929
---
2030

@@ -30,9 +40,10 @@
3040

3141
#### Back-end:
3242

33-
- **Node.js с Express.js** – серверная часть для обработки запросов (была уже реализована).
43+
- **Node.js** – серверная часть для обработки запросов.
3444
- **REST API** – используется для взаимодействия между клиентом и сервером.
3545
- **JSON** – формат хранения данных о клиентах.
46+
- **Render** – платформа для хостинга серверной части (сервер переходит в "спящий" режим при простое, поэтому первая загрузка может занять несколько секунд).
3647

3748
---
3849

@@ -73,15 +84,16 @@ project-root/
7384
- Взаимодействие с сервером (GET, POST, PATCH, DELETE запросы).
7485
- Валидация введённых данных.
7586
- Обновление интерфейса при изменении данных.
87+
- Отображение спиннера при загрузке данных с сервера.
7688

7789
#### Работа с API
7890

79-
Система взаимодействует с сервером через REST API:
91+
Система взаимодействует с сервером через REST API, развернутый на Render:
8092

81-
- `GET /api/clients` – получение списка клиентов.
82-
- `POST /api/clients` – добавление нового клиента.
83-
- `PATCH /api/clients/:id` – обновление данных клиента.
84-
- `DELETE /api/clients/:id` – удаление клиента.
93+
- `GET https://skillbus-crm.onrender.com/api/clients` – получение списка клиентов.
94+
- `POST https://skillbus-crm.onrender.com/api/clients` – добавление нового клиента.
95+
- `PATCH https://skillbus-crm.onrender.com/api/clients/:id` – обновление данных клиента.
96+
- `DELETE https://skillbus-crm.onrender.com/api/clients/:id` – удаление клиента.
8597

8698
---
8799

@@ -91,6 +103,7 @@ project-root/
91103
2. **Валидация данных** – проверка ввода для различных типов контактов (телефон, email, соцсети).
92104
3. **Адаптивность** – дизайн подстраивается под разные экраны.
93105
4. **Интерактивные элементы** – тултипы, анимации, плавные переходы.
106+
5. **Спиннер загрузки** – отображается при получении данных с удалённого сервера.
94107

95108
---
96109

@@ -114,7 +127,7 @@ node index.js
114127

115128
### Заключение
116129

117-
Этот проект - "практикум" по завершению обучающего блока по JavaScript "Basic Level". Работа над CRM-системой была долгой и кропотливой, но она позволила значительно углубить понимание JavaScript, принципов работы с DOM, REST API и клиент-серверного взаимодействия.
130+
Этот проект - "практикум" по завершению обучающего блока по JavaScript "Basic Level". Работа над CRM-системой позволила значительно углубить понимание JavaScript, принципов работы с DOM, REST API и клиент-серверного взаимодействия.
118131

119132
- Процесс разработки дал ценный опыт в написании чистого и структурированного кода, улучшил навыки работы с асинхронными запросами и манипуляциями с интерфейсом.
120133
- Проект демонстрирует не только технические навыки, но и умение продумывать архитектуру приложения, писать поддерживаемый код и учитывать пользовательский опыт.
67.6 KB
Loading

0 commit comments

Comments
 (0)