Giter VIP home page Giter VIP logo

vue-django's Introduction

vue-django-webpack-boilerplate

A full-featured Webpack setup with hot-reload, lint-on-save, unit testing & css extraction integrated into a django application

Code Climate

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.

Documentation

Common topics are discussed in the docs. Make sure to read it!

Usage

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-cli

You might want to use sudo if you encounter permissions error

$ vue init NdagiStanley/vue-django my-project
$ cd my-project
$ npm install

Secondly, have Python installed and preferably create a virtual environment for the project.

To develop

$ npm run dev

Deploy

To deploy your django project

$ .deploy.sh

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:8000

Then get to 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.
    • 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.html is 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.

Contributions

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

vue-django's People

Contributors

anvaka avatar blake-newman avatar chrisvfritz avatar codincat avatar crookedneighbor avatar elusivespirit avatar grafikart avatar jbruni avatar jpokrzyk avatar kzima avatar liufei avatar miljan-aleksic avatar nblackburn avatar ndagistanley avatar oaleynik avatar pespantelis avatar posva avatar rascada avatar xiaoyual666 avatar yyx990803 avatar zigomir avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.