A full-featured Webpack setup with hot-reload, lint-on-save, unit testing & css extraction integrated into a django application
If you are using vue-cli@1.x, it will be pulling the master branch of this template by default. If you are using vue-cli@2.x, it will be pulling the dist branch instead, which provides more configurable options thanks to new features in vue-cli@2.x. It is recommended to upgrade vue-cli as soon as you can.
Common topics are discussed in the docs. Make sure to read it!
This is a project template for vue-cli. It is recommended to use npm 3+ for a more efficient dependency tree.
$ npm install -g vue-cliYou might want to use sudo if you encounter permissions error
$ vue init NdagiStanley/vue-django my-project
$ cd my-project
$ npm installTo develop
$ npm run devTo deploy your django project
$ npm run buildEdit the values href and src attributes of the bundled css and js (respectively) in index.html in the templates folder like this:
(Pretty-fied HTML)
{% load staticfiles %}
<!DOCTYPE html>
<html>
<head>
<meta charset=utf-8>
<title>Vue Django</title>
<link href={% static 'app.369373ee5bfac83b1712b5ac3ebad93a.css' %} rel=stylesheet>
</head>
<body>
<app></app>
<script type=text/javascript src={% static 'app.2b5e8c77e6df2615ff26.js' %}></script>
</body>
</html>$ pip install -r requirements.txt
$ python manage.py collectstatic --noinput
$ python manage.py migrate
$ python manage.py runserver
Then get to localhost:8000. You should have a page exactly like the image below.
Docker
You can run a docker container for it simply by running the following command. Ensure that docker is running.
docker run -p 8000:8000 stanmd/vue-django python manage.py runserver 0.0.0.0:8000Then get to localhost:8000. You should have a page exactly like the image above
-
npm run dev: first-in-class development experience.- Webpack +
vue-loaderfor single file Vue components. - State preserving hot-reload
- State preserving compilation error overlay
- Lint-on-save with ESLint
- Source maps
- Webpack +
-
npm run build: Production ready build.- JavaScript minified with UglifyJS.
- HTML minified with html-minifier.
- CSS across all components extracted into a single file and minified with cssnano.
- All static assets compiled with version hashes for efficient long-term caching, and a production
index.htmlis auto-generated with proper URLs to these generated assets.
-
npm run unit: Unit tests run in PhantomJS with Karma + Mocha + karma-webpack.- Supports ES2015 in test files.
- Supports all webpack loaders.
- Easy mock injection.
-
npm run e2e: End-to-end tests with Nightwatch.- Run tests in multiple browsers in parallel.
- Works with one command out of the box:
- Selenium and chromedriver dependencies automatically handled.
- Automatically spawns the Selenium server.
NB: This repo has been forked from vue-webpack-boilerplate to build help you start a Django application utilizing the awesomeness of Vue JS and vue-cli
Feel free to contribute to this repo.
To create your own boilerplate, fork this repo or vue-webpack-boilerplate and use it with vue-cli:
vue init username/repo my-project