Routine scrutiny of the boilerplate (#215)

* Update testing on the boilerplate

* Update README

* Update django from 2.0.5 to 2.0.7 (#214)

* Update message after vue-cli command run

* Fix reported error on Github issues

* Update boilerplate

* Add coveralls badge

Author: NdagiStanley

README.md

@@ -1,6 +1,6 @@
 # vue-django-webpack-boilerplate
 
-> [@NdagiStanley](https://github.com/NdagiStanley) has mirrored the [fork](https://github.com/NdagiStanley/vue-django-fork) to have this repo here. This starterpack has proved useful to many and I thank you for the emails I have received from all of you. The reasoning behind this mirror is that this is an effort to **support the users** more by develop further on this project. From here on, I am calling on all potential collaborators by making it easier to make [PRs](https://github.com/NdagiStanley/vue-django/pulls) and adding utility of [Issues](https://github.com/NdagiStanley/vue-django/issues) in this 'new' repo (Of course with the same name :) ). Lastly, just so you know, I'll be keeping up with developments in the [`original`](https://github.com/vuejs-templates/webpack).
+> [@NdagiStanley](https://github.com/NdagiStanley) has mirrored the [fork](https://github.com/NdagiStanley/vue-django-fork) to have this repo here. This starterpack has proved useful to many and I thank you for the emails I have received from all of you. The reasoning behind this mirror is that this is an effort to **support the users** more by developing further on this project. From here on, I am calling on all potential collaborators by making it easier to make [PRs](https://github.com/NdagiStanley/vue-django/pulls) and adding utility of [Issues](https://github.com/NdagiStanley/vue-django/issues) in this 'new' repo (Of course with the same name :) ). Lastly, just so you know, I'll be keeping up with developments in the [`original`](https://github.com/vuejs-templates/webpack).
 
 <p align="center">
   <b>Listed in</b>
@@ -26,6 +26,7 @@ Common topics are discussed in the [docs](http://vuejs-templates.github.io/webpa
 [![Build Status](https://semaphoreci.com/api/v1/stanmd/vue-django/branches/develop/badge.svg)](https://semaphoreci.com/stanmd/vue-django)
 [![Updates](https://pyup.io/repos/github/NdagiStanley/vue-django/shield.svg)](https://pyup.io/repos/github/NdagiStanley/vue-django/)
 [![Python 3](https://pyup.io/repos/github/NdagiStanley/vue-django/python-3-shield.svg)](https://pyup.io/repos/github/NdagiStanley/vue-django/)
+[![Coverage Status](https://coveralls.io/repos/github/NdagiStanley/vue-django/badge.svg)](https://coveralls.io/github/NdagiStanley/vue-django)
 
 [https://vuedjango.herokuapp.com/](https://vuedjango.herokuapp.com/) is a deployed instance of this boilerplate.
 
@@ -38,6 +39,8 @@ This is a project template that includes `VueJS` and `Django` based on the [vue-
 ``` bash
 $ npm install -g vue-cli
 ```
+
+### Set up
 You might want to use ```sudo``` if you encounter permissions error
 ```bash
 $ vue init NdagiStanley/vue-django my-project
@@ -47,18 +50,26 @@ $ npm install
 
 Secondly, have *Python* installed and preferably create a virtual environment for the project.
 
-To develop
-
+### Develop
+Run:
 ```bash
 $ npm run dev
 ```
 
-## Deploy
-To deploy your django project, still within `my-project` directory, run:
+The app runs on [localhost:8080](http://localhost:8080/)
+
+Update the files as you wish and the hot-reload will take effect. Add `js` and `css` files within the `static` folder in the root directory. Link them to the index.html in that same level (the root directory).
 
-`$ .deploy.sh`
+### Deploy
+Ensure you have run `npm install` prior to the following command.
+
+Run:
+```bash
+$ .deploy.sh
+```
+(Run this command every time you make changes)
 
-Then get to [localhost:8000](http://localhost:8000/). You should have a page exactly like the image below or as the deployed instance mentioned earlier: [https://vuedjango.herokuapp.com/](https://vuedjango.herokuapp.com/)
+At [localhost:8000](http://localhost:8000/) you should have a page exactly like the image below or as the deployed instance mentioned earlier: [https://vuedjango.herokuapp.com/](https://vuedjango.herokuapp.com/)
 
 <p align="center">
   <img src="http://i.imgur.com/sY3IpBE.png?1" align="center" height="500" alt="Vue-Django">

docs/README.md

@@ -73,22 +73,31 @@ If you desire to use VueJS version 2.x with Django vesion 1.x run:
 ```bash
 $ cd my-project
 $ npm install
+```
+
+### Development
+
+Run:
+```bash
 $ npm run dev
 ```
 
+and edit away. `Hot reload` is enabled so any changes on `index.html` and the other files will reflect on [localhost:8080](http://localhost:8080/)
+
 ### Deploy with Django (Locally)
 
 Ensure python and pip is installed. Preferably create a virtual environment for the project.
 
 ```bash
-$ npm set progress=false && npm install -s --no-progress && npm run build
+$ npm run build
 $ pip install -r requirements.txt
 $ python format_index_html.py
 $ python manage.py collectstatic --noinput
+$ python manage.py migrate
 $ python manage.py runserver 0.0.0.0:8000
 ```
 
-The 5 commands above are contained in the `deploy.sh` so running the script is as good as running the aforementioned commands:
+The 6 commands above are contained in the `deploy.sh` so running the script is as good as running the aforementioned commands:
 ```
 $ ./deploy.sh
 ```

meta.js

@@ -125,5 +125,5 @@ module.exports = {
     "test/e2e/**/*": "e2e",
     "src/router/**/*": "router"
   },
-  "completeMessage": "To get started:\n\n  {{^inPlace}}cd {{destDirName}}\n  {{/inPlace}}npm install\n  npm run dev\n\nTo build and serve in Django:\n\n  ./deploy.sh\n\nDocumentation can be found at https://goo.gl/V4eN7h"
+  "completeMessage": "To get started:\n\n  {{^inPlace}}cd {{destDirName}}\n  {{/inPlace}}npm install\n\n  To develop:\n\n  npm run dev\n\nTo build and serve in Django:\n\n  ./deploy.sh  (Remember to do this in a python virtual environment)\n\nDocumentation can be found at https://goo.gl/V4eN7h"
 };

template/.gitignore

@@ -39,6 +39,7 @@ coverage.xml
 # Django stuff:
 *.log
 local_settings.py
+db.sqlite3
 
 # dotenv
 .env

template/config/index.js

@@ -53,8 +53,8 @@ module.exports = {
     index: path.resolve(__dirname, '../templates/index.html'),
 
     // Paths
-    assetsRoot: path.resolve(__dirname, '../templates'),
-    assetsSubDirectory: 'static',
+    assetsRoot: path.resolve(__dirname, '../'),
+    assetsSubDirectory: 'static-vuedj',
     assetsPublicPath: '/',
 
     /**

template/deploy.sh

@@ -1,5 +1,5 @@
-echo 'Running npm install & npm build'
-npm set progress=false && npm install -s --no-progress && npm run build
+echo 'Run npm build'
+npm run build
 echo 'Done...'
 
 echo 'Format index.html as Jinja template'
@@ -14,6 +14,10 @@ echo 'Collect static'
 python manage.py collectstatic --noinput
 echo 'Done...'
 
+echo 'Run migrations'
+python manage.py migrate
+echo 'Done...'
+
 export PORT=8000
 echo 'Server runnning on port ' $PORT
 python manage.py runserver

template/format_index_html.py

@@ -1,15 +1,15 @@
 import sys
 import fileinput
 
-file = 'index.html'
+file = 'templates/index.html'
 
 with open(file, "r+") as f:
     s = f.read()
     f.seek(0)
     f.write("{% load staticfiles %}\n" + s)
 
 for i, line in enumerate(fileinput.input(file, inplace=1)):
-    sys.stdout.write(line.replace('/static/', "{% static '"))
+    sys.stdout.write(line.replace('/static-vuedj/', "{% static '"))
 for i, line in enumerate(fileinput.input(file, inplace=1)):
     sys.stdout.write(line.replace('.css', ".css' %}"))
 for i, line in enumerate(fileinput.input(file, inplace=1)):

template/requirements.txt

@@ -1,4 +1,4 @@
 coverage==4.5.1
 coveralls==1.3.0
-Django==2.0.5
+Django==2.0.7
 django-nose==1.4.5

template/static/css/.gitkeep

@@ -123,7 +123,7 @@
 # https://docs.djangoproject.com/en/2.0/howto/static-files/
 
 STATICFILES_DIRS = (
-    os.path.join(BASE_DIR, 'templates/static'),
+    os.path.join(BASE_DIR, 'static-vuedj'),
 )
 
 STATIC_ROOT = os.path.join(BASE_DIR, 'staticfiles')

template/static/js/.gitkeep

@@ -1,11 +1,9 @@
 #!/usr/bin/expect -f
-
 # To be used primarily in CI (continuous integration)
 set timeout 360
 set BRANCH_NAME $env(BRANCH_NAME)
 
 spawn vue init NdagiStanley/vue-django#$BRANCH_NAME my-project
-
 expect {
     "Project name" { send "\n"; exp_continue }
     "Project version" { send "\n"; exp_continue }