Digital Campus Framework
DCF contains core scripts and styles which are used as 'plumbing' and a foundation to build a theme. The core scripts and styles create a more consistent user experience and ease of development across themes, while each individual theme allows for customizations and brand identity.
- The
/coredirectory contains the core scripts and files for DCF. - The
/themedirectory contains sub-directories for each theme. Individual themes are not bundled with this project, and should instead be placed in the/themedirectory during development to build it.
- The
/theme/name/cssdirectory is where generated css will be placed. - The
/theme/name/jsdirectory is where generated js will be placed.
Run npm install to install the required node modules.
You are good to go!
Run the following command to build the development files:
npm run dev -- --env.theme your_theme_name
for example: npm run dev -- --env.theme example will build the example theme that lives in /theme/example.
Run the following command to build the production files:
npm run dev -- --env.theme your_theme_name
Webpack has entry points for head and body js. After writing your JS (or during), add a require statement for it in the
appropriate /theme/theme_name/js/loaders/ file.