Skip to content

Latest commit

 

History

History
34 lines (26 loc) · 2.11 KB

README.md

File metadata and controls

34 lines (26 loc) · 2.11 KB

cms-vue-boilerplate [beta]

Boilerplate Vue project for creating apps using modules on the HubSpot CMS

Getting Started

For more information on local development tools, see Local Development Tooling: Getting Started

Configuration

Set up HubSpot CMS CLI (@hubspot/cms-cli)

  • A config file named hubspot.config.yml will also be needed. The config can be at the project level or higher up in the directory tree.
  • Be sure to set a defaultPortal in your hubspot.config.yml to which you'd like the built app files to sync.

Install

  • Run npm install or yarn install to install needed dependencies.

Running

  • Run npm start or yarn start to automatically upload your project to defaultPortal.
  • Create a page from default theme, or any drag-and-drop (dnd_area) enabled template in your portal, and add the module(see snippet below).
    {% module "cms_vue_boilerplate" path="./cms-vue-boilerplate/modules/app" label="CMS Vue Boilerplate" %}
    

package.json scripts

  • start : Builds project with webpack, uploads to your defaultPortal specified in hubspot.config.yml and watches for changes via @hubspot/webpack-cms-plugins/HubSpotAutoUploadPlugin.
  • build : Clears /dist contents and builds project into /dist.
  • deploy : Clears /dist contents, builds project into /dist, and uploads to via @hubspot/cms-cli.
  • lint : Lints CSS, JS, and JSON files via eslint (documentation) and checks for formatting via prettier(documentation) in src.
    • For configs, see prettier.config.js and eslintrc.js.
  • prettier:write : Formats JS and JSON files in src.
    • For configs, see prettier.config.js.