swordfox/vite

Vite Frontend Tooling, Lightning Fast HMR for SilverStripe 4

Maintainers

Details

github.com/swordfox/vite

Source

Issues

Installs: 2 059

Dependents: 2

Suggesters: 0

Security: 0

Stars: 4

Watchers: 3

Forks: 0

Open Issues: 0

Type:silverstripe-vendormodule

3.2.6 2024-05-06 20:30 UTC

This package is auto-updated.

Last update: 2024-06-06 20:41:57 UTC


README

Vite Silverstripe logo


Silverstripe Vite Plugin

Vite is a modern frontend build tool that provides an extremely fast development environment and bundles your code for production.

This plugin configures Vite for use with Silverstripe.

Install

To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line, in the root folder of your project:

  1. Install the plugin
composer require swordfox/vite
  1. Copy vite yml config
cp vendor/swordfox/vite/_config/vite.yml.example app/_config/vite.yml

Make sure to set the path to images folder of your theme assetsImageFolder

You can also use extra_requirements_css, editor_css as shown in the config, in order to apply custom css to admin environment through Vite

  1. Copy vite config
cp vendor/swordfox/vite/vite.config.js.example vite.config.js

You might need to update paths to your assets in vite.config.js, eg.: themes/custom/src/app.scss

  1. Prepare package.json

We need to set up package.json in our project root folder. Use it for all frontend packages. If you have one, make sure to include npm scripts follows:

  "scripts": {
    "dev": "vite",
    "build": "vite build",
    "preview": "vite preview"
  },

and install necessary packages:

npm install laravel-vite-plugin autoprefixer@latest sass --save-dev

or run the command to copy example package.json from the source folder to start with

cp vendor/swordfox/vite/package.json.example package.json
  1. Finally, run
npm install
  1. Add APP_URL to your .env with the local address of your website
APP_URL=//mywebsite.com
# APP_URL_CDN="//cdn.mywebsite.com"
ASSET_URL=${APP_URL}
SS_BASE_URL=${APP_URL}

PUSHER_APP_ID=
PUSHER_APP_KEY=
PUSHER_APP_SECRET=
PUSHER_HOST=
PUSHER_PORT=443
PUSHER_SCHEME=https
PUSHER_APP_CLUSTER=mt1

VITE_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
VITE_PUSHER_HOST="${PUSHER_HOST}"
VITE_PUSHER_PORT="${PUSHER_PORT}"
VITE_PUSHER_SCHEME="${PUSHER_SCHEME}"
VITE_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"

How To Use

We need to include css in our head tag

<head>
  ...
  $Vite.CSS.RAW
</head>

The same goes with js requirements, but it can be included in body tag instead, at the very bottom

<body>
  ...
  $Vite.JS.RAW
</body>

Excellent! Next, let's get into a groove. For dev environment you need to run

npm run dev

Compiling for Production

npm run build

In order to add assets in your template .ss files you can use these helpers:

$Vite.asset('themes/custom/src/images/image.jpg')

or, shortcut if you set assetsImageFolder in your vite.yml as mentioned above

$Vite.image('image.jpg')

You can also reach vite helper through SiteConfig

$SiteConfig.Vite.image('image.jpg')

Make sure to include glob import that will handle assets on npm run build. To do so, add this at the very top of your main js file. You might need to update paths or include other assets that are involved in your own build.

import.meta.glob([
  './images/**',
  './fonts/**',
]);

Don't forget to update your .gitignore by adding these

/public/hot
/public/build/

You are all set now, enjoy.