Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
53 lines (34 sloc) 1.86 KB

Dashboard Asset Compilation

We don't change CSS files directly. We use Sass for better-structured CSS, which requires a build process. You only need to do this if you're developing the core product. Otherwise, put any changes you want to make to Vanilla's CSS in your theme instead.

Installing Dependencies

Compiling the assets for the dashboard application has a few dependencies. You will need node.js and yarn.

For macOS

MacOS users can easily install the dependencies with Homebrew. Using homebrew is optional but is generally the easiest setup. You can also install them manually using the above links.

brew install node
brew install yarn

For Debian/Ubuntu Linux

curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list

sudo apt-get update && sudo apt-get install nodejs yarn

Then install the local dependencies using yarn install.

cd /path/to/vanilla
cd applications/dashboard

yarn install

Tasks

Build (Run once)

$ yarn build

Compiles all theme assets using Grunt. SCSS stylesheets will be compiled to design/admin.css and Javascript in the js/src directory will be concatenated and output to js/dashboard.js.

Watch (run continuously)

$ yarn watch

Watches the assets for changes and runs the appropriate re-runs the individual parts of the build. Also starts a LiveReload server that will automatically reload your browser after every compilation. To make use of this, install the LiveReload browser extension.

You can’t perform that action at this time.