Integration of ViteJS in a Django project.
Project description
Django Vite
Integration of ViteJS in a Django project.
Installation
Django
pip install django-vite
Add django_vite to your INSTALLED_APPS in your settings.py
(before your apps that are using it).
INSTALLED_APPS = [
...
'django_vite',
...
]
ViteJS
Follow instructions on https://vitejs.dev/guide/. And mostly the SSR part.
Then in your ViteJS config file :
- Set the
rootoptions the same as yourSTATIC_URLDjango setting. - Set the
build.outDirpath to where you want the assets to compiled. - Set the
build.manifestoptions totrue. - As you are in SSR and not in SPA, you don't have an
index.htmlthat ViteJS can use to determine which files to compile. You need to tell it directly. In your ViteJS config file add the following :
export default defineConfig({
build {
...
rollupOptions: {
input: {
<unique key>: '<path to your asset>'
}
}
}
}
Usage
Configuration
-
Define a setting variable in your
settings.pynamedDJANGO_VITE_ASSETS_PATHcontaining the absolute path to where your assets are built.- This must correspond to your
build.outDirin your ViteJS configuration. - The
DJANGO_VITE_ASSETS_PATHmust be included in yourSTATICFILES_DIRSDjango setting.
- This must correspond to your
-
Define a setting variable in your
settings.pynamedDJANGO_VITE_DEV_MODEcontaining a boolean defining if you want to include assets in development mode or production mode.- In development mode, assets are included as modules using the ViteJS webserver. This will enable HMR for your assets.
- In production mode, assets are included as standard assets (no ViteJS webserver and HMR) like default Django static files. This means that your assets must be compiled with ViteJS before.
- This setting may be set as the same value as your
DEBUGsetting in Django. But you can do what is good for yout needs.
Template tags
Include this in your base HTML template file.
{% load django_vite %}
Then in your <head> element add this :
{% vite_hmr_client %}
- This will add a
<script>tag to include the ViteJS HMR client. - This tag will include this script only if
DJANGO_VITE_DEV_MODEis true, otherwise this will do nothing.
Then add this tag to load your scripts :
{% vite_asset '<path to your asset>' %}
This will add a <script> tag including your JS/TS script :
- In development mode, all scripts are included as modules.
- In development mode, all scripts are marked as
asyncanddefer. - You can pass a second argument to this tag to overrides attributes passed to the script tag.
- This tag only accept JS/TS, for other type of assets, they must be
included in the script itself using
importstatements. - In production mode, the library will read the
manifest.jsonfile generated by ViteJS and import all CSS files dependent of this script (before importing the script). - You can add as many of this tag as you want, for each input you specify in your ViteJS configuration file.
- The path must be relative to your
rootkey inside your ViteJS config file. - The path must be a key inside your manifest file
manifest.jsonfile generated by ViteJS. - In general, this path does not require a
/at the beginning (follow yourmanifest.jsonfile).
{% vite_asset_url '<path to your asset>' %}
This will generate only the URL to an asset with no tag surrounding it. Warning, this does not generate URLs for dependant assets of this one like the previous tag.
Miscellaneous configuration
You can redefine those variables in your settings.py :
DJANGO_VITE_DEV_SERVER_PROTOCOL: ViteJS webserver protocol (default :http).DJANGO_VITE_DEV_SERVER_HOST: ViteJS webserver hostname (default :localhost).DJANGO_VITE_DEV_SERVER_PORT: ViteJS webserver port (default :3000)DJANGO_VITE_WS_CLIENT_URL: ViteJS webserver path to the HMR client used in thevite_hmr_clienttag (default :@vite/client).DJANGO_VITE_MANIFEST_PATH: Absolute path (including filename) to your ViteJS manifest file. This file is generated in yourDJANGO_VITE_ASSETS_PATH. But if you are in production (DEBUGis true) then it is in yourSTATIC_ROOTafter you collected your static files.
Notes
- In production mode, all generated path are prefixed with the
STATIC_URLsetting of Django.
Thanks
Thanks to Evan You for the ViteJS library.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django_vite-1.0.2-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7d8c522cb93f8fa1b79b4809f83eead2a7d55c72d442ee4aa1d9f6220ae0f614 |
|
| MD5 | af0ec22ed49b86fecfc9137fe0a95740 |
|
| BLAKE2b-256 | 5d82ea22d95b80068b694d1724d9a903167908519900bd8f3edcf0e873ab1d9c |
