https://github.com/HubSpot/cms-theme-boilerplate
A straight-forward starting point for building a great website on the HubSpot CMS
https://github.com/HubSpot/cms-theme-boilerplate
Last synced: over 1 year ago
JSON representation
A straight-forward starting point for building a great website on the HubSpot CMS
- Host: GitHub
- URL: https://github.com/HubSpot/cms-theme-boilerplate
- Owner: HubSpot
- License: other
- Created: 2014-04-08T15:45:14.000Z (about 12 years ago)
- Default Branch: main
- Last Pushed: 2024-05-14T13:01:20.000Z (about 2 years ago)
- Last Synced: 2024-07-05T14:40:59.621Z (about 2 years ago)
- Language: HTML
- Homepage: https://boilerplate.hubspotcms.com
- Size: 12.3 MB
- Stars: 344
- Watchers: 189
- Forks: 350
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
HubSpot CMS Boilerplate
A straight-forward starting point for building a great website on the HubSpot CMS.
Documentation |
Demo website |
Contributing
[](https://github.com/HubSpot/cms-theme-boilerplate/releases)
[](https://github.com/HubSpot/cms-theme-boilerplate/commits/main)
[](https://github.com/HubSpot/cms-theme-boilerplate/graphs/contributors)
[](https://github.com/HubSpot/cms-theme-boilerplate/watchers)
[](https://github.com/HubSpot/cms-theme-boilerplate/stargazers)
[](https://github.com/HubSpot/cms-theme-boilerplate/network/members)
[](https://website.grader.com/tests/boilerplate.hubspotcms.com)
[](https://developers.google.com/web/tools/lighthouse)
[](https://developers.google.com/web/tools/lighthouse)
[](https://developers.google.com/web/tools/lighthouse)
[](https://github.com/HubSpot/cms-theme-boilerplate/blob/main/LICENSE)
## Purpose
The [HubSpot CMS Boilerplate](https://designers.hubspot.com/docs/building-blocks/themes/hubspot-cms-boilerplate) is designed to offer developers a head start in the website building process. While the HubSpot CMS 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!
## Getting started
### To download the HubSpot CMS Boilerplate using the HubSpot CMS CLI:
Before getting started, you will need to have [Node.js](https://nodejs.org) installed, the [HubSpot CMS CLI](https://developers.hubspot.com/docs/cms/guides/getting-started-with-local-development#install-dependencies) installed, and we strongly suggest that you set up a [HubSpot CMS Developer Sandbox](https://offers.hubspot.com/free-cms-developer-sandbox) for your QA/testing environment.
1. Navigate to the directory that you want to use for your project
2. Run `hs create website-theme ` to create a project from the HubSpot CMS Boilerplate
3. [Configure](https://developers.hubspot.com/docs/cms/guides/getting-started-with-local-development#configure-the-local-development-tools) the local development tools for the portal(s) you'd like to use for your project.
4. Run `hs watch --portal= src --initial-upload` to upload all the files in the project and [watch for changes](https://developers.hubspot.com/docs/cms/developer-reference/local-development-cms-cli#watch) to files in the `src` directory
Please reference our _[Quick start guide to developing on the HubSpot CMS](https://developers.hubspot.com/docs/cms/guides/getting-started)_ and our _[Getting started with local development](https://designers.hubspot.com/tutorials/getting-started-with-local-development)_ articles for more information.
### To use version control in your project using GitHub and GitHub Actions:
1. [Fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the HubSpot CMS Boilerplate repository and [clone](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) your forked repository to your computer
2. [Set up GitHub secrets in your forked repository to encrypt sensitive information from showing publically](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) for `HUBSPOT_PORTAL_ID` and `HUBSPOT_PERSONAL_ACCESS_KEY`
3. Update the name of the directory that you'll be deploying to in your Design Manager in the `.github/workflows/deploy.yml` file (the current default `dest_dir` is `cms-theme-boilerplate`)
4. Deploy changes to your Design Manager by pushing to the `main` branch of your forked repository
Please reference our [_HubSpot CMS deploy GitHub action page_](https://github.com/marketplace/actions/hubspot-cms-deploy) and _[Setting up continuous integration with a GitHub repository using GitHub Actions article](https://designers.hubspot.com/tutorials/github-integration)_ for more information.
## Style guide
For details about the HubSpot CMS Boilerplate's recommended best practices and code formatting, please reference our [style guide](https://github.com/HubSpot/cms-theme-boilerplate/blob/master/STYLEGUIDE.md).
## Contributing
If you’re interested in contributing to the HubSpot CMS Boilerplate, please read [CONTRIBUTING.md](https://github.com/HubSpot/cms-theme-boilerplate/blob/master/CONTRIBUTING.md) and [STYLEGUIDE.md](https://github.com/HubSpot/cms-theme-boilerplate/blob/master/STYLEGUIDE.md) to see how you can report an issue, make a feature request, or make a pull request.
## Versioning
Previous releases and their documentation are available for [download](https://github.com/HubSpot/cms-theme-boilerplate/releases). To provide transparency into future releases, we create a project board that documents our planning in preparation for each [upcoming major and minor version](https://github.com/HubSpot/cms-theme-boilerplate/projects).
## Community
You can stay up to date with HubSpot CMS Boilerplate updates and discussions in the #hs-cms-boilerplate channel in the [HubSpot Developer Slack](https://designers.hubspot.com/slack).
## License
The code is available under the [Apache License, Version 2.0](https://github.com/HubSpot/cms-theme-boilerplate/blob/main/LICENSE)