From 2a84cd69384f73b4803a516af0d97c84e7492d1c Mon Sep 17 00:00:00 2001
From: Alexandr Karpov <alexandr.d.karpov@gmail.com>
Date: Sun, 23 Oct 2022 01:39:35 +0300
Subject: [PATCH] added README

---
 README.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d56ccf0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,62 @@
+# Tender Hack backend
+
+Серверная часть приложения по умному поиску товаров
+
+### Запуск
+```shell
+$ python3 -m venv venv && source venv/bin/activate
+$ pip install -r requirements/base.txt
+$ ./app/manage.py makemigrations && ./app/manage.py migrate
+$ ./app/manage.py loaddata products.json # не возможно положить в git репозиторий
+$ ./app/manage.py runserver
+```
+
+<br>
+
+### Описание фильтров для API
+###### фильтры можно применять в неограниченным количеством списком в запросе
+
+#### Запрос по всем полям
+###### так же поддерживается поиск по числовым характеристикам, например: размер 100
+```json
+{
+  "value": "любая строчка, в том числе с ошибками",
+  "type": "All"
+}
+```
+#### Запрос по имени продукта
+```json
+{
+  "value": "часть имени товара, в любой раскладке, с ошибками и т д",
+  "type": "Name"
+}
+```
+#### Запрос категории продуктов
+```json
+{
+  "value": "часть имени категории, с ошибками и т д",
+  "type": "Category"
+}
+```
+#### Запрос по имени характеристики
+```json
+{
+  "value": "часть значения характеристики, с ошибками и т д",
+  "type": "Characteristic"
+}
+```
+#### Запрос по имени и значению характеристики
+```json
+{
+  "value": "значение характеристики",
+  "type": "часть названия характеристики"
+}
+```
+#### Фильтрация по значению цифровой характеристики
+###### операторы: = >= <= < >, так же поддерживается ранжированные значения
+```json
+{
+  "value": ">=100",
+  "type": "*Размер"
+}
+```