gvsafronov/futriix
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Григорий Сафронов 2025-07-21 18:23:21 +00:00
parent 1c11d80a26
commit 1517c068fa
1 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -82,6 +82,8 @@ Futriix является резидентной субд, т.е. храняще
* Команды, выполняемые с привилегиями суперпользователя (root), отмечены символом приглашения **«#»** * Команды, выполняемые с привилегиями суперпользователя (root), отмечены символом приглашения **«#»**
* Команды, выполняемые с правами обычного пользователя(user), отмечены символом приглашения **«$»** * Команды, выполняемые с правами обычного пользователя(user), отмечены символом приглашения **«$»**
* **FutBot** - интеллектуальный помощник в мессенджере Телеграмм, помогающий осущесвлять быстрый поиск по документации проекта * **FutBot** - интеллектуальный помощник в мессенджере Телеграмм, помогающий осущесвлять быстрый поиск по документации проекта
* **futriix** - сервер проекта futriix
* **Clif (CLient Futriix)**- клиент проекта futriix
## Подготовка ## Подготовка
@ -128,7 +130,19 @@ Futriix является резидентной субд, т.е. храняще
4. Запускаем серверв futriix'а с помощью команды `./futriix` 4. Запускаем серверв futriix'а с помощью команды `./futriix`
```sh ```sh
$ ./futriix $ ./futriix
Futriix Server started successfully!
18:18:58 [INFO] Starting server on 127.0.0.1:8080
18:18:58 [INFO] Log file: logs/futriix_21.07.2025 21-18-58.log
18:18:58 [INFO] Symlink: futriix.log
18:18:58 [INFO] Starting server on 127.0.0.1:8080
18:18:58 [INFO] Server::run; addr=0.0.0.0:8081
18:18:58 [INFO] listening on http://0.0.0.0:8081
18:18:58 [INFO] Futriix Server started successfully!
18:18:58 [INFO] Listening on: 127.0.0.1:8080
18:18:58 [INFO] HTTP API available on: 0.0.0.0:8081
``` ```
5. Для запуска тестов запускаем команды: 5. Для запуска тестов запускаем команды:
```sh ```sh
$ cargo test --test integration # запуск только интеграционных тестов $ cargo test --test integration # запуск только интеграционных тестов
@ -146,6 +160,13 @@ Futriix является резидентной субд, т.е. храняще
Запускаем клиент Futriix, перейдя в каталог с исходным кодом: Запускаем клиент Futriix, перейдя в каталог с исходным кодом:
```sh ```sh
$ cd /target/realease && ./clif $ cd /target/realease && ./clif
Futriix CLI Client
Connected to server at 127.0.0.1:8080
Type 'help' for available commands
futriix:~> insert user1 {"name": "Alice", "age": 25}
``` ```
Проверяем доступность сервера, выполняяя команду `insert`, если будет получен ответ `successful`-значит вставка данных работает корректно Проверяем доступность сервера, выполняяя команду `insert`, если будет получен ответ `successful`-значит вставка данных работает корректно