From d0930fd73a025a4bfb8f02a320fd1379bd854c73 Mon Sep 17 00:00:00 2001 From: Arsen Mirzaev Tatyano-Muradovich Date: Thu, 16 Jan 2025 14:27:27 +0700 Subject: [PATCH] fixed for github --- README.md | 51 ++++++++++++++++++++++++++------------------------- 1 file changed, 26 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 0f0addb..f1414d2 100755 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Base for creating shop chat-robots using Web App technology for ![Telegram](http ## Functions 1. Tree-structured catalog -2. Product cards with images carousel based on ![mirzaev/hotline.mjs](https://git.svoboda.works/mirzaev/hotline.mjs) +2. Product cards with images carousel (![mirzaev/hotline.mjs](https://git.svoboda.works/mirzaev/hotline.mjs)) 3. Cart (CRUD with limits and session binding) 4. Saving user data (and session) for all devices 5. Deliveries settings (with interactive maps and automatic geolocation detection on smartphones) @@ -67,7 +67,7 @@ Base for creating shop chat-robots using Web App technology for ![Telegram](http ### AnangoDB 1. **Configure unix-socket**
-
+ Edit the file `/etc/arangodb3/arangod.conf`
`endpoint = tcp://127.0.0.1:8529` -> `endpoint = unix:///var/run/arangodb3/arango.sock` (this will disable the web panel)

@@ -98,15 +98,16 @@ upstream arangodb { ![here is my solution for "permission denied" problem on Ubuntu (accepted by ArangoDB maintainer)](https://github.com/arangodb/arangodb/issues/17302)
1. **Configure TCP (instead of unix-socket)**
-
+ Edit the file `/etc/arangodb3/arangod.conf`
`endpoint = tcp://127.0.0.1:8529` -> `endpoint = tcp://0.0.0.0:8529`
-
+ Edit the file `mirzaev/huesos/system/settings/arangodb.php`
-`unix:///var/run/arangodb3/arango.sock` -> `tcp://YOUR_IP_ADDRESS:8529` (it is slow and not secure)
+`unix:///var/run/arangodb3/arango.sock` -> `tcp://YOUR_IP_ADDRESS:8529` (it is slow and not secure) + --- + 2. **Create a Graph with the specified values**
-
**Name:** catalog
* Relation 1
@@ -118,37 +119,42 @@ Edit the file `mirzaev/huesos/system/settings/arangodb.php`
**edgeDefinition:** reservation
**fromCollections:** product
**toCollections:** cart + --- + 3. **Create a Graph with the specified values**
-
**Name:** users
* Relation 1
**edgeDefinition:** connect
**fromCollections:** cart, session
**toCollections:** account, session
-
-**Orphan Collections:** product + +* Orphan Collections
+product + --- + 4. **Create indexes for the "product" collection**
-
**Type:** "Inverted Index"
**Fields:** name.ru
**Analyzer:** "text_ru"
**Search field:** true
-**Name:** name_ru
-
+**Name:** name_ru

+ *Add indexes for all search parameters and for all languages (search language is selected based on the user's language,
otherwise from the default language specified in the active settings from **settings** collection document)*

*See fields in the `mirzaev/arming_bot/models/product`
**name.ru**, **description.ru** and **compatibility.ru***
+ --- -5. **Create a View with the specified values** + +5. **Create a View with the specified values**
**type:** search-alias (you can also use "arangosearch")
**name:** **product**s_search
-**indexes:**
-
+**indexes:**

+ You can copy an example of view file from here: `/examples/arangodb/views/products_search.json` ```json @@ -170,17 +176,14 @@ Edit the file `/etc/nginx/mime.types`
`application/javascript js;` -> `application/javascript js mjs;` ### SystemD (or any alternative you like) -You can copy an example of systemd file from here: `/examples/systemd/huesos.service`
-
-**Execute:** `sudo cp huesos.service /etc/systemd/system/huesos.service && sudo chmod +x /etc/systemd/system/huesos.service`
-
+You can copy an example of systemd file from here: `/examples/systemd/huesos.service`

+**Execute:** `sudo cp huesos.service /etc/systemd/system/huesos.service && sudo chmod +x /etc/systemd/system/huesos.service`

*before you execute the command think about **what it does** and whether the **paths** are specified correctly*
*the configuration file is very simple and you can remake it for any alternative to SystemD that you like* ## Menu -Menu inside the Web App
-
+*Menu inside the Web App*

Make sure you have a **menu** collection (can be created automatically)
You can copy a clean menu documents without comments from here: `/examples/arangodb/collections/menu` @@ -208,8 +211,7 @@ You can copy a clean menu documents without comments from here: `/examples/arang ``` ## Settings -Settings of chat-robot and Web App
-
+*Settings of chat-robot and Web App*

Make sure you have a **settings** collection (can be created automatically) and at least one document with the "status" parameter set to "active"
You can copy a clean settings document without comments from here: `/examples/arangodb/collections/settings.json` @@ -233,8 +235,7 @@ You can copy a clean settings document without comments from here: `/examples/ar ``` ## Suspensions -System of suspensions of chat-robot and Web App
-
+*System of suspensions of chat-robot and Web App*

Make sure you have a **suspension** collection (can be created automatically)
You can copy a clean suspension document without comments from here: `/examples/arangodb/collections/suspension.json` ```json