feat: Added README
This commit is contained in:
41
README.md
Normal file
41
README.md
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
# Status page
|
||||||
|
|
||||||
|
#### How to run server:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
./status server
|
||||||
|
```
|
||||||
|
|
||||||
|
#### How to run documentation server:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
./status server-docs
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Example `--help` command:
|
||||||
|
|
||||||
|
```
|
||||||
|
0.0.1
|
||||||
|
Usage: status <command> [<args>]
|
||||||
|
|
||||||
|
Options:
|
||||||
|
--help, -h display this help and exit
|
||||||
|
--version display version and exit
|
||||||
|
|
||||||
|
Commands:
|
||||||
|
server Start the api server
|
||||||
|
server-docs Generate documentation for api server
|
||||||
|
```
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
To configure application follow these table of Env:
|
||||||
|
|
||||||
|
| Name | Example | Definition |
|
||||||
|
|---------------|----------------|------------|
|
||||||
|
| DATABASE_HOST | localhost | - |
|
||||||
|
| DATABASE_PORT | 5432 | - |
|
||||||
|
| DATABASE_USER | someUserName | - |
|
||||||
|
| DATABASE_PASS | strongPassword | - |
|
||||||
|
| DATABASE_DB | statuspage | - |
|
||||||
|
| DATABASE_TZ | Europe/Moscow | - |
|
||||||
Reference in New Issue
Block a user