wchen02/cms-theme-boilerplate

A straight-forward starting point for building a great website on the HubSpot CMS

HubSpot CMS Boilerplate

A straight-forward starting point for building a great website on the HubSpot CMS.

Purpose

The HubSpot CMS Boilerplate is designed to offer developers a head start in the website building process. While the boilerplate represents HubSpot's opinionated best practices, we intend to learn from similar projects and feedback. We hope it offers inspiration and utility for all website projects!

You can find the demo site at boilerplate.hubspotcms.com.

Follow and star the repository to stay up-to-date with product releases and evolving best practices for building websites on the HubSpot CMS through PRs of the boilerplate.

Getting started

The HubSpot CMS boilerplate is designed to work with both local development and the HubSpot Design Tools. To get started, you will need to have Node.js installed. When getting started, we strongly suggest that you set up a HubSpot CMS Developer Sandbox.

1. Navigate to the directory that you want to use for your project
2. Run npx @hubspot/create-cms-project <directory> to create a project from the boilerplate
3. Create a hubspot.config.yml file and configure the CLI so that you can upload files to the HubSpot portals that you use
4. Run npx hs watch --portal=<portal> src <directory> to upload all the files in the boilerplate and watch for changes to files in the src directory

For more details about development best practices, see the styleguide.

To learn more about the HubSpot CMS, visit designers.hubspot.com and explore the documentation.