From 52e69f57835e1f99df4d64ccafb583e4a155234a Mon Sep 17 00:00:00 2001 From: Will Roberts Date: Thu, 22 Jun 2017 00:50:27 +0200 Subject: [PATCH] README: document webpack asset management --- {{cookiecutter.app_name}}/README.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/{{cookiecutter.app_name}}/README.rst b/{{cookiecutter.app_name}}/README.rst index 7ef2f35..5c1d216 100644 --- a/{{cookiecutter.app_name}}/README.rst +++ b/{{cookiecutter.app_name}}/README.rst @@ -40,6 +40,23 @@ database tables and perform the initial migration :: flask db upgrade flask run +Files placed inside the ``assets`` directory and its subdirectories +will be copied by webpack's ``file-loader`` into the ``static/build`` +directory, with hashes of their contents appended to their names. For +instance, if you have the file ``assets/img/favicon.ico``, this will +get copied into something like +``static/build/img/favicon.fec40b1d14528bf9179da3b6b78079ad.ico``. +You can then put this line into your header:: + + + +to refer to it inside your HTML page. If all of your assets are +managed this way, you can ask Flask to tell web browsers that they +should cache your static files forever by including the following line +in your ``settings.py``:: + + SEND_FILE_MAX_AGE_DEFAULT = 31556926 # one year + Deployment ----------