Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commitb670655

Browse files
committed
Update Readme file with API swagger docs 📝
1 parentafa4ee4 commitb670655

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

‎README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ Urless is written in Python, using Redis as its primary database.( TODO redisgea
2020
Download the latest version of URLess via this image 'alivx/urless'.
2121

2222
```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.
2525
```
2626

2727
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
4444

4545
If you want to use a custom config under docker-compose, just add it under`environment` section as explained above.
4646

47-
<imgsrc="https://raw.githubusercontent.com/alivx/urless/master/resources/docker-compose-env-vars.png"alt="docker-compose-env-vars"style="zoom:50%;" />
47+
<imgsrc="https://raw.githubusercontent.com/alivx/urless/master/resources/docker-compose-env-vars.png"alt="docker-compose-env-vars"style="zoom:40%;" />
4848

4949
You can change value for each service config under file`settings.yaml`
5050

51-
<imgsrc="https://raw.githubusercontent.com/alivx/urless/master/resources/frontend-config.png"alt="frontend-config"style="zoom:50%;" />
51+
<imgsrc="https://raw.githubusercontent.com/alivx/urless/master/resources/frontend-config.png"alt="frontend-config"style="zoom:40%;" />
5252

5353
For nginx, you must change the config file under`infrastructure/nginx/urless.conf` if you changes`frontend` container name or port.
5454

55-
<imgsrc="https://raw.githubusercontent.com/alivx/urless/master/resources/nginx.png"alt="nginx"style="zoom:50%;" />
55+
<imgsrc="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+
<imgsrc="https://raw.githubusercontent.com/alivx/urless/master/resources/BackendAPI.png"alt="APiDocs"style="zoom:50%;" />

‎resources/BackendAPI.png

16.4 KB
Loading

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp