lasagnamassage / cms-react-boilerplate

cms-react-boilerplate [beta]

Boilerplate React project for creating apps using modules on the HubSpot CMS.

NOTE:

The cms-react-boilerplate legacy repository is a starting place for building and running a SPA (single page application) style React App on a HubSpot page. The React build itself is not directly connected to HubSpot.

Recently HubSpot has released "CMS JS Building Blocks" for general availability. Read documentation and view examples here. The "building blocks" feature directly integrates React on the server and the client with HubSpot and enables building HubSpot modules in React. Further, it builds on the HubSpot Developer Projects system which provides CI/CD build and deploy functionality.

Getting Started

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

Configuration

Set up HubSpot CMS CLI (@hubspot/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 app (label: React app boilerplate) module.

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/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.