Vitalizer
Webpack development and bundling tool for Vital Software.
Features
- Hot reloading
- Injected JS/CSS assets
- Tree-shaking optimization
- Cache busted production assets
- Source map support
- PostCSS (Autoprefixer, cssnext, SCSS style syntax)
- cssnano minification
- rem() function support
Installing
To install, run the following commands:
yarn add vitalizer -D
Usage
Development
To run Vitalizer in development mode (using webpack-serve), run the following command:
vitalizer start
To build your project files for production, run the following command:
vitalizer build
Configuration
To configure Vitalizer, create a file called .env
in the root of your project:
VARIABLE=name
And set any of the following variables:
Variable | Development | Production | Usage |
---|
API_PROXY_HOST | :white_check_mark: | :x: | Set this value to configure the API proxy host (i.e. api.vital ) |
API_PROXY_URL | :white_check_mark: | :x: | Set this value to configure the API proxy url (i.e. https://api.vital ) |
CI | :large_orange_diamond: | :white_check_mark: | When set to true , Vitalizer treats warnings as failures in the build. Most CIs set this flag by default. |
DISABLE_HASH | :x: | :white_check_mark: | When set to true , production assets are output as [name].[ext] rather than [name][hash].[ext] . Useful for debugging and test purposes. |
HOST | :white_check_mark: | :x: | By default, the development web server binds to localhost . You may use this variable to specify a different host. |
PORT | :white_check_mark: | :x: | By default, the development web server will attempt to listen on port 3000 or prompt you to attempt the next available port. You may use this variable to specify a different port. |
RESOLVE_MODULES | :white_check_mark: | :white_check_mark: | Comma seperated list of module roots to use other than node_modules . i.e. app, static |
Expanding Environment Variables In .env
Expand variables already on your machine for use in your .env
file (using dotenv-expand).
For example, to use the DOMAIN
variable:
DOMAIN=www.example.com
FOO=$DOMAIN/foo
BAR=$DOMAIN/bar