Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/NdagiStanley/vue-django
@Django integrated with a full-featured @Webpack + (@vuejs / vue-loader) setup with hot reload, linting, testing & css extraction.
https://github.com/NdagiStanley/vue-django
django vuejs webpack
Last synced: 11 days ago
JSON representation
@Django integrated with a full-featured @Webpack + (@vuejs / vue-loader) setup with hot reload, linting, testing & css extraction.
- Host: GitHub
- URL: https://github.com/NdagiStanley/vue-django
- Owner: NdagiStanley
- License: mit
- Created: 2017-08-23T15:56:38.000Z (about 7 years ago)
- Default Branch: develop
- Last Pushed: 2024-02-08T05:18:11.000Z (9 months ago)
- Last Synced: 2024-04-13T21:05:29.866Z (7 months ago)
- Topics: django, vuejs, webpack
- Language: JavaScript
- Homepage: https://code.md.engineer/vue-django/
- Size: 322 KB
- Stars: 520
- Watchers: 17
- Forks: 84
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 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 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 the 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).
Listed in
> A full-featured Webpack setup with hot-reload, lint-on-save, unit testing & css extraction integrated into a django application
## Vue CLI Version Notice
If you are using `[email protected]`, it will be pulling the `master` branch of this template by default. If you are using `[email protected]`, it will be pulling the `dist` branch instead, which provides more configurable options thanks to new features in `[email protected]`. It is recommended to upgrade `vue-cli` as soon as you can.
## VueJS Templates Documentation
Common topics are discussed in the [docs](http://vuejs-templates.github.io/webpack). Make sure to read it!
# Vue Django
[](https://github.com/ellerbrock/open-source-badge/)
[](https://www.codetriage.com/ndagistanley/vue-django)
[](https://semaphoreci.com/stanmd/vue-django)
[](https://coveralls.io/github/NdagiStanley/vue-django)
[](https://microbadger.com/images/stanmd/vue-django "Get your own image badge on microbadger.com")
[](https://microbadger.com/images/stanmd/vue-django "Get your own version badge on microbadger.com")
[https://vuedjango.herokuapp.com/](https://vuedjango.herokuapp.com/) is a deployed instance of this boilerplate.
[Vue-Django Docs](https://ndagistanley.github.io/vue-django/) offer a more comprehensive documentation.
## Usage of VueDjango
This is a project template that includes `VueJS` and `Django` based on the [vue-cli](https://github.com/vuejs/vue-cli) templates. **It is recommended to use npm 3+ for a more efficient dependency tree.**
``` 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 # Follow the prompts
$ cd my-project
$ npm install
```
### Develop
Run:
```bash
$ npm run dev
```
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).
### Run the Django server
Have *Python* installed and preferably use a [virtual python environment](#virtualenv) for this.
Run:
```bash
$ python -m pip install -r requirements.txt
$ sh server.sh
```
(Run this command every time you make changes)
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/)
> Docker
##### Ensure that **docker** is running.
If you use `docker` in your workflow, there is a `Dockerfile` in the root directory for you. Simply run
```
docker build -t [image-name] .
```
Use your preferred _image name_ in place of the `image-name` in the command. Remember to enter the trailing period before running it.
There is a docker container for vue-django that you can run. Simply run the following command.
```bash
docker run -p 8000:8000 stanmd/vue-django
```
Then get to [localhost:8000](http://localhost:8000/). You should have a page exactly like the image above
## What's Included
- `npm run dev`: first-in-class development experience.
- Webpack + `vue-loader` for single file Vue components.
- State preserving hot-reload
- State preserving compilation error overlay
- Lint-on-save with ESLint
- Source maps
- `npm run build`: Production ready build.
- JavaScript minified with [UglifyJS](https://github.com/mishoo/UglifyJS2).
- HTML minified with [html-minifier](https://github.com/kangax/html-minifier).
- CSS across all components extracted into a single file and minified with [cssnano](https://github.com/ben-eb/cssnano).
- All static assets compiled with version hashes for efficient long-term caching, and a production `index.html` is auto-generated with proper URLs to these generated assets.
- `npm run unit`: Unit tests run in PhantomJS with [Karma](http://karma-runner.github.io/0.13/index.html) + [Mocha](http://mochajs.org/) + [karma-webpack](https://github.com/webpack/karma-webpack).
- Supports ES2015 in test files.
- Supports all webpack loaders.
- Easy mock injection.
- `npm run e2e`: End-to-end tests with [Nightwatch](http://nightwatchjs.org/).
- 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.
## Community
### Contributions
**NB**: This repo has been forked from vue-webpack-boilerplate to help you start a Django application utilizing the awesomeness of `VueJS` and `vue-cli`
Feel free to contribute to this repo.
To create your own boilerplate, fork this repo or [vue-webpack-boilerplate](https://github.com/vuejs-templates/webpack) and use it with `vue-cli`:
``` bash
vue init username/repo my-project
```
### Star History
If this repo is helpful to you, please star it. Thanks!
### Backers
[](#backers)
Thank you to all our backers!
