Skip to content

Commit

Permalink
upd docs
Browse files Browse the repository at this point in the history
Signed-off-by: Login Victor <batazor111@gmail.com>
  • Loading branch information
batazor committed Apr 5, 2021
1 parent eb5bf9d commit 0e80f0e
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 19 deletions.
23 changes: 4 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,15 @@ Shortlink service

| Service | Description | Language/Framework | Docs |
|-------------|--------------------------------------|--------------------|------------------------------------------|
| api | GateWay/Main service | Go | |
| api | GateWay | Go | [docs](./docs/services/api.md) |
| link | Link service | Go | [docs](./docs/services/link.md) |
| logger | Logger service | Go | |
| metadata | Parser site by API | Go | |
| bot | Send notify to smtp, slack, telegram | Go | |
| shortctl | Shortlink CLI | Go | [docs](./docs/shortctl.md) |
| csi | CSI example | Go | |
| ory/kratos | User management service | Go | [docs](https://www.ory.sh/kratos/docs/ ) |
| ory/hydra | OAuth 2.0 Provider | Go | [docs](https://www.ory.sh/keto/docs/ ) |
| ory/kratos | User management service | Go | [docs](https://www.ory.sh/kratos/docs/) |
| ory/hydra | OAuth 2.0 Provider | Go | [docs](https://www.ory.sh/keto/docs/) |

### Run

Expand Down Expand Up @@ -105,22 +106,6 @@ make skaffold-debug
+ [NATS](https://nats.io/)
+ [RabbitMQ](https://www.rabbitmq.com/)

### Store provider

+ RAM
+ MongoDB
+ Postgres
+ ***Optional***
+ Redis
+ MySQL
+ LevelDB
+ Badger
+ SQLite
+ Scylla
+ Сassandra (via: Scylla driver)
+ RethinkDB
+ DGraph

### Cloud-Native

+ Development
Expand Down
1 change: 1 addition & 0 deletions docs/services/api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# API Services
24 changes: 24 additions & 0 deletions docs/services/link.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Link services

Service for work with link-domain (CRUD)

### Store provider

> support - enabled batch mode; filter, etc...
> scale - scalability/single mode
| Name | Support | Scale |
|---------------------------------|-----------|----------|
| RAM |||
| MongoDB |||
| Postgres |||
| Redis |||
| MySQL |||
| LevelDB |||
| Badger |||
| SQLite |||
| Scylla |||
| Сassandra (via: Scylla driver) |||
| RethinkDB |||
| DGraph |||

0 comments on commit 0e80f0e

Please sign in to comment.