Skip to content

Commit

Permalink
Update Readme file with API swagger docs 📝
Browse files Browse the repository at this point in the history
  • Loading branch information
alivx committed Dec 24, 2020
1 parent afa4ee4 commit b670655
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ Urless is written in Python, using Redis as its primary database.( TODO redisgea
Download the latest version of URLess via this image 'alivx/urless'.

```Bash
docker-compose build
docker-compose up
docker-compose build #To build project
docker-compose up #To run project, You can use `-d` option to run it in the background.
```

To test service run CURL command:
Expand All @@ -44,12 +44,17 @@ In point 2, just use `DYNACONF_[valueName]`, for example, in our API there is a

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

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

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

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

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

<img src="https://raw.githubusercontent.com/alivx/urless/master/resources/nginx.png" alt="nginx" style="zoom:50%;" />
<img src="https://raw.githubusercontent.com/alivx/urless/master/resources/nginx.png" alt="nginx" style="zoom:40%;" />


----
You can check the API documntion by `/docs`
<img src="https://raw.githubusercontent.com/alivx/urless/master/resources/BackendAPI.png" alt="APiDocs" style="zoom:50%;" />
Binary file added resources/BackendAPI.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 b670655

Please sign in to comment.