Skip to content

Commit

Permalink
Added TUI and REST to Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
F1bonacc1 committed May 9, 2022
1 parent 396b07e commit 298adaf
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 4 deletions.
32 changes: 28 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ Process compose is a lightweight utility for building custom workflows and execu

It is heavily inspired by [docker-compose](https://github.com/docker/compose), but without the need for containers. The configuration syntax tries to follow the docker-compose specifications, with a few minor additions and lots of subtractions.

<img src="./imgs/tui.png" alt="TUI" style="zoom:67%;" />

### Installation

- Go to the [releases](https://github.com/F1bonacc1/process-compose/releases/latest), download the package for your OS, and copy the binary to somewhere on your PATH.
Expand Down Expand Up @@ -86,6 +88,24 @@ process2:
#### ✅ <u>TUI</u> (Terminal User Interface)
##### ✅ Review processes status
##### ✅ Start processes (only completed or disabled)
##### ✅ Stop processes
##### ✅ Review logs
TUI is the default run mode, but it's possible to disable it:
```shell
./process-compose -t=false
```



#### ✅ <u>Logger</u>

##### ✅ Per Process Log Collection
Expand Down Expand Up @@ -167,15 +187,19 @@ environment:
- 'I_AM_GLOBAL_EV=42'
```

Default environment variables:

`PC_PROC_NAME` - Defines the process name as defined in the `process-compose.yaml` file.

`PC_REPLICA_NUM` - Defines the process replica number. Useful for port collision avoidance for processes with multiple replicas.


#### ❌ <u>System Variables</u>

##### ❌ Process replica number
#### ✅ <u>REST API</u>

##### ❌ Monitoring
A convenient Swagger API is provided: http://localhost:8080/swagger/index.html

##### ❌ REST API
<img src="./imgs/swagger.png" alt="Swagger" style="zoom:67%;" />



Expand Down
Binary file added imgs/swagger.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added imgs/tui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 298adaf

Please sign in to comment.