Flask Vue App

Flask + Vue.js Web Application

Quickstart

Build and run the server and client docker images:

make run

Original README

Features

Minimal Flask 1.0 App
Flask-RestPlus API with class-based secure resource routing
Starter PyTest test suite
vue-cli 3 + yarn
Vuex
Vue Router
Axios for backend communication
Sample Vue Filters
Heroku Configuration with one-click deployment + Gunicorn

Demo

Live Demo

Alternatives

If this setup is not what you are looking for, here are some similar projects:

Template Structure

The template uses Flask & Flask-RestPlus to create a minimal REST style API, and let's VueJs + vue-cli handle the front end and asset pipline. Data from the python server to the Vue application is passed by making Ajax requests.

Application Structure

Rest Api

The Api is served using a Flask blueprint at /api/ using Flask RestPlus class-based resource routing.

Client Application

A Flask view is used to serve the index.html as an entry point into the Vue app at the endpoint /.

The template uses vue-cli 3 and assumes Vue Cli & Webpack will manage front-end resources and assets, so it does overwrite template delimiter.

The Vue instance is preconfigured with Filters, Vue-Router, Vuex; each of these can easilly removed if they are not desired.

Important Files

Location	Content
`/app`	Flask Application
`/app/api`	Flask Rest Api (`/api`)
`/app/client.py`	Flask Client (`/`)
`/src`	Vue App .
`/src/main.js`	JS Application Entry Point
`/public/index.html`	Html Application Entry Point (`/`)
`/public/static`	Static Assets
`/dist/`	Bundled Assets Output (generated at `yarn build`

Installation

Before you start

Before getting started, you should have the following installed and running:

Yarn - instructions
Vue Cli 3 - instructions
Python 3

Template and Dependencies

Clone this repository:

 $ git clone https://github.com/gtalarico/flask-vuejs-template.git

Setup virtual environment, install dependencies, and activate it:
```
 $ pipenv install --dev
 $ pipenv shell
```
Install JS dependencies
```
 $ yarn install
```

Development Server

Run Flask Api development server:

$ python run.py

From another tab in the same directory, start the webpack dev server:

$ yarn serve

The Vuejs application will be served from localhost:8080 and the Flask Api and static files will be served from localhost:5000.

The dual dev-server setup allows you to take advantage of webpack's development server with hot module replacement.

Proxy config in vue.config.js is used to route the requests back to Flask's Api on port 5000.

If you would rather run a single dev server, you can run Flask's development server only on :5000, but you have to build build the Vue app first and the page will not reload on changes.

$ yarn build
$ python run.py

agalea91/flask-vuejs-template