Skip to content

Commit 0572454

Browse files
committed
Update docs
1 parent ff89c5c commit 0572454

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

+13-8
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,15 @@
22

33
## Overview
44

5-
The classified platform such as Craigslist or Avito that provides the opportunity for peer-to-peer exchanges of goods and services.
5+
The classified platform such as Craigslist or Avito that provides the opportunity for peer-to-peer exchanges of goods
6+
and services.
67

78
<img src="docs/overview-arch.png" width="600" alt="overview-arch"/>
89

910
## How to launch
1011

11-
Run one of the sbt commands below to start the selected component locally with connection to other services in the Cloud.
12+
Run one of the sbt commands below to start the selected component locally with connection to other services in the
13+
Cloud.
1214

1315
```bash
1416
sbt "project service" run
@@ -34,7 +36,8 @@ Before executing the above commands, you need to specify some environment variab
3436
```
3537
for Telegram bot
3638

37-
For example, `sbt "project service" run` will launch the REST API locally, but it will send requests to PostgreSQL and Redis in the Cloud
39+
For example, `sbt "project service" run` will launch the REST API locally, but it will send requests to PostgreSQL and
40+
Redis in the Cloud
3841

3942
### Using Docker
4043

@@ -102,9 +105,10 @@ create table user_offers
102105

103106
create table photos
104107
(
105-
id uuid primary key,
106-
url text default null,
107-
blob bytea default null
108+
id uuid primary key,
109+
url text default null,
110+
blob bytea default null,
111+
telegram_id text default null
108112
);
109113

110114
create table offer_photos
@@ -153,12 +157,13 @@ And authorization separately:
153157

154158
### Parsing
155159

156-
Parsing gets offers from youla.ru to fill in the contents of my service
160+
Parsing gets offers from youla.ru to fill in the contents of my service
157161

158162
<img src="docs/parsing-arch.png" width="600" alt="parsing-arch"/>
159163

160164
### Moderation
161165

162-
Moderation Worker requests all offers with the `OnModeration` status from the REST API (in batches, with some delay) and then updating offer statuses to Active or Banned if any violations are detected
166+
Moderation Worker requests all offers with the `OnModeration` status from the REST API (in batches, with some delay) and
167+
then updating offer statuses to Active or Banned if any violations are detected
163168

164169
<img src="docs/moderation-arch.png" width="450" alt="moderation-arch"/>

0 commit comments

Comments
 (0)