Explorar o código

README: Adding instructions for project setup

David Leonard %!s(int64=10) %!d(string=hai) anos
pai
achega
270724940d
Modificáronse 1 ficheiros con 21 adicións e 0 borrados
  1. 21 0
      README.md

+ 21 - 0
README.md

@@ -5,6 +5,27 @@ Django Hackathon Starter
 
 > Django Hackathon Starter aims to be a project which will aggegrate data from several APIs, producing a RESTful API which can be consumed by a client (also intended to be built). 
 
+## Running this project
+
+In order to run this project, do the following:
+
+    # Install the requirements
+    pip install -r requirements.txt
+
+    # Perform database migrations
+    python manage.py migrate
+
+    # Run the server
+    python manage.py runserver
+
+Two routes have currently been set up, which are located at:
+
+    # First test route
+    http://127.0.0.1:8000/hackathon/
+
+    # Second test route
+    http://127.0.0.1:8000/hackathon/test
+
 ## Contributors
 
 * David Leonard