updated readme and makefile (#10)

* updated readme and makefile
OSDG-IIITH · May 31, 2020 · 328dd6d · 328dd6d
1 parent ce86679
commit 328dd6d
Show file tree

Hide file tree

Showing 12 changed files with 43 additions and 13 deletions.
diff --git a/src/README.md b/src/README.md
@@ -1,17 +1,44 @@
 # Source
-Will contain the backend and front end pieces 
+Will contain the backend and front end pieces
 -------------
 # art-club-website
-Art Club website at IIIT-H <br/> 
-virtual env can be activated by <br/>
+Art Club website at IIIT-H <br/>
+
+I have kept all the project files in ./src directory <br/>
+project name: webpage <br/>
+app name : webapp <br/>
+
+to get started
+```console
+foo@bar:~/art-club-website/src$ make
+```
+this installs requirements and takes you to virtual env
+<br>
+<br>
+```console
+foo@bar:~/art-club-website/src$ python3 ./mange.py runserver
+```
+gets the server running on localhost ie.  http://127.0.0.1:8000/<br>
+<br>
+#### Advanced:
+For only activating virtual env:
 ```console
-foo@bar:~/art-club-website/src$ source bin/activate
+foo@bar:~/art-club-website/src$ make activate
 ```
-or you can simply install by running
+for only installing required packages:
 
 ```console
-foo@bar:~/art-club-website/src$ make
+foo@bar:~/art-club-website/src$ make install
+```
+for exiting virtual env:
+`deactivate`
+<br>
+for changing the server's port
+```console
+foo@bar:~/art-club-website/src$ python3 ./mange.py runserver <port number>
+```
+If you want to change the server’s IP, pass it along with the port
+<br> (make sure to add it in ALLOWED_HOSTS in /art-club-website/src/webpage/settings.py)
+```console
+foo@bar:~/art-club-website/src$ python3 ./mange.py runserver <ip addrs>:<port number>
 ```
-I have kept all the project files in ./src directory <br/>
-project name: webpage <br/>
-app name : webapp <br/>
diff --git a/src/makefile b/src/makefile
@@ -1,4 +1,7 @@
-all: a
-
-a:
+all:
 	pip3 install -r requirements.txt
+	source bin/activate
+install:
+	pip3 install -r requirements.txt
+env:
+	source bin/activate
diff --git a/src/webapp/__pycache__/__init__.cpython-38.pyc b/src/webapp/__pycache__/__init__.cpython-38.pyc
diff --git a/src/webapp/__pycache__/admin.cpython-38.pyc b/src/webapp/__pycache__/admin.cpython-38.pyc
diff --git a/src/webapp/__pycache__/models.cpython-38.pyc b/src/webapp/__pycache__/models.cpython-38.pyc
diff --git a/src/webapp/__pycache__/views.cpython-38.pyc b/src/webapp/__pycache__/views.cpython-38.pyc
diff --git a/src/webapp/migrations/__pycache__/__init__.cpython-38.pyc b/src/webapp/migrations/__pycache__/__init__.cpython-38.pyc
diff --git a/src/webpage/__pycache__/__init__.cpython-38.pyc b/src/webpage/__pycache__/__init__.cpython-38.pyc
diff --git a/src/webpage/__pycache__/settings.cpython-38.pyc b/src/webpage/__pycache__/settings.cpython-38.pyc
diff --git a/src/webpage/__pycache__/urls.cpython-38.pyc b/src/webpage/__pycache__/urls.cpython-38.pyc
diff --git a/src/webpage/__pycache__/wsgi.cpython-38.pyc b/src/webpage/__pycache__/wsgi.cpython-38.pyc
diff --git a/src/webpage/settings.py b/src/webpage/settings.py
@@ -25,7 +25,7 @@
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = True
 
-ALLOWED_HOSTS = []
+ALLOWED_HOSTS = ['0.0.0.0']
 
 
 # Application definition