@@ -20,8 +20,8 @@ Urless is written in Python, using Redis as its primary database.( TODO redisgea
20
20
Download the latest version of URLess via this image 'alivx/urless'.
21
21
22
22
``` Bash
23
- docker-compose build
24
- docker-compose up
23
+ docker-compose build# To build project
24
+ docker-compose up# To run project, You can use `-d` option to run it in the background.
25
25
```
26
26
27
27
To test service run CURL command:
@@ -44,12 +44,17 @@ In point 2, just use `DYNACONF_[valueName]`, for example, in our API there is a
44
44
45
45
If you want to use a custom config under docker-compose, just add it under` environment ` section as explained above.
46
46
47
- <img src =" https://raw.githubusercontent.com/alivx/urless/master/resources/docker-compose-env-vars.png " alt =" docker-compose-env-vars " style =" zoom :50 % ;" />
47
+ <img src =" https://raw.githubusercontent.com/alivx/urless/master/resources/docker-compose-env-vars.png " alt =" docker-compose-env-vars " style =" zoom :40 % ;" />
48
48
49
49
You can change value for each service config under file` settings.yaml `
50
50
51
- <img src =" https://raw.githubusercontent.com/alivx/urless/master/resources/frontend-config.png " alt =" frontend-config " style =" zoom :50 % ;" />
51
+ <img src =" https://raw.githubusercontent.com/alivx/urless/master/resources/frontend-config.png " alt =" frontend-config " style =" zoom :40 % ;" />
52
52
53
53
For nginx, you must change the config file under` infrastructure/nginx/urless.conf ` if you changes` frontend ` container name or port.
54
54
55
- <img src =" https://raw.githubusercontent.com/alivx/urless/master/resources/nginx.png " alt =" nginx " style =" zoom :50% ;" />
55
+ <img src =" https://raw.githubusercontent.com/alivx/urless/master/resources/nginx.png " alt =" nginx " style =" zoom :40% ;" />
56
+
57
+
58
+ ----
59
+ You can check the API documntion by` /docs `
60
+ <img src =" https://raw.githubusercontent.com/alivx/urless/master/resources/BackendAPI.png " alt =" APiDocs " style =" zoom :50% ;" />