Update README.md

bounswe · Oct 31, 2023 · dad6a44 · dad6a44
1 parent cd80a10
commit dad6a44
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/ludos/backend/README.md b/ludos/backend/README.md
@@ -1 +1,7 @@
-Backend of LUDOS project
+# LUDOS Backend Api
+Deployed Swagger Documentation: http://3.125.225.39:8080/api 
+## How to run?
+```WORKDIR=./ludos/backend```<br/>
+1. Create a .env file for the environment variables. Please ask for the variables. The name of the variables are included in .env.example file. <br/>
+2. Run ```docker-compose up --build``` <br/>
+3. Now, the api is available with localhost:8080 base url.