소스 검색

add readme file for the project

sxoinas12 2 년 전
부모
커밋
4c3aaa7f57
1개의 변경된 파일26개의 추가작업 그리고 0개의 파일을 삭제
  1. 26 0
      README.md

+ 26 - 0
README.md

@@ -0,0 +1,26 @@
+# Telecaster Project Instructions
+
+### Fetch repository
+#### `git clone http://onarbooks.com/Klapi/Telecaster.git`
+
+## Setup
+#### `cd telecaster`
+
+### Install requirments
+#### `pip3 install -r requirments.txt`
+
+### How to test?
+
+#### `cd telecaster`
+
+#### `python manage.py runserver`
+
+#### Open postman and perform a `POST` request with the below payload
+
+#### `url: localhost:8000/generate/xml`
+```
+{
+    "url": "prestashop_domain",
+    "token": "your_secret_token"
+}
+```