{"id":22409015,"url":"https://github.com/hubspotwebteam/cms-sample-project","last_synced_at":"2026-03-19T22:46:27.370Z","repository":{"id":95245915,"uuid":"596321529","full_name":"HubSpotWebTeam/cms-sample-project","owner":"HubSpotWebTeam","description":null,"archived":false,"fork":false,"pushed_at":"2023-02-09T13:43:31.000Z","size":119,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-29T10:38:07.919Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HubSpotWebTeam.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-02-01T23:33:29.000Z","updated_at":"2023-02-27T17:15:32.000Z","dependencies_parsed_at":"2023-04-26T06:19:23.432Z","dependency_job_id":null,"html_url":"https://github.com/HubSpotWebTeam/cms-sample-project","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/HubSpotWebTeam/cms-sample-project","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HubSpotWebTeam%2Fcms-sample-project","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HubSpotWebTeam%2Fcms-sample-project/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HubSpotWebTeam%2Fcms-sample-project/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HubSpotWebTeam%2Fcms-sample-project/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HubSpotWebTeam","download_url":"https://codeload.github.com/HubSpotWebTeam/cms-sample-project/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HubSpotWebTeam%2Fcms-sample-project/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29812622,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-25T05:36:42.804Z","status":"ssl_error","status_checked_at":"2026-02-25T05:36:31.934Z","response_time":61,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-05T12:06:21.261Z","updated_at":"2026-02-25T06:44:46.112Z","avatar_url":"https://github.com/HubSpotWebTeam.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cms-sample-project\n\nThis is a starter project for HubSpot CMS projects.\n\n## Getting started\n\nClone this template repository and run `npm install` to install dependencies.\n\n\u003e These guidelines are an abridged version of the [getting started with local development](https://developers.hubspot.com/docs/cms/guides/getting-started-with-local-development) docs. Please refer to them if you encounter any issues.\n\nFirst you'll need to install the [HubSpot CLI](https://developers.hubspot.com/docs/cms/hubspot-cli) tools.\n\nThen run `hs init`, which will walk you through the following steps:\n\n1. First you'll create a personal CMS access key to enable authenticated access to your account via the local development tool\n2. Next, you’ll enter a name for the account. This name is only seen and used by you, but for consistencies sake we recommend using `DEV` for your sandbox portal.\n\nOnce you've completed this simple init flow, you'll see a success message confirming that a configuration file, `hubspot.config.yml`, has been created in your current directory. It will look something like this:\n\n```yaml\ndefaultPortal: sandbox\nportals:\n  - name: sandbox\n    portalId: 123\n    authType: personalaccesskey\n    personalAccessKey: \u003e-\n      xxxxxxxxx-xxxxxxx-xxxxxxx-xxxxxxx-xxxxxxxx\n    auth:\n      tokenInfo:\n        accessToken: \u003e-\n          xxxxxxxxx-xxxxxxx-xxxxxxx-xxxxxxx-xxxxxxxx\n        expiresAt: '2023-02-24T19:38:39.164Z'\n```\n\nNow, you can run `npm run start` in your terminal. This will automatically build your project, and upload the output files to your `DEV` portal. Webpack will watch for changes and automatically upload them as you make them.\n\n## Deploying to QA or Production\n\nTo deploy to QA or Production, you'll need to create a `QA` or `PROD` portal in your `hubspot.config.yml` file. You can do this by running `hs init` again and selecting the appropriate portal name.\n\nOnce you've created a QA or PROD portal, you can deploy to it by running `npm run deploy:qa` or `npm run deploy:prod`.\n\n## Customizing the build\n\nYou can customize your build by editing the `webpack.config.js` file. We include a default `cmsConfig` that includes plugins and settings to build your project, but you can add or remove plugins as needed. You can see the default configuration [here](https://github.com/HubSpotWebTeam/webpack-config/blob/main/src/configs/cms.config.js).\n\nFor example, by default Webpack will upload the `/dist` folder contents to a `sample-site` folder in your CMS portal. You can change this by editing the `cmsConfig`:\n\n```js\ncmsConfig({\n  portal: 'DEV',\n  cmsSrc: 'dist',\n  cmsDest: '\u003ccms-folder-to-upload-to\u003e',\n  ...,\n}),\n```\n\n## Coding standards\n\nWe include a custom EsLint and Stylelint configurations. You can customize these by editing the `.eslintrc.js` and `.stylelintrc.js` files, though we encourage you to stick to the standards we've set.\n\nIf you want to use TypeScript, we have a [separate package](https://github.com/HubSpotWebTeam/wt-eslint-typescript) you can install:\n\n```bash\nnpm i -D @hs-web-team/eslint-config-ts\n```\n\nUpdate the `.eslintrc` file:\n\n```js\n// .eslintrc\n{\n  \"extends\": [\n    \"@hs-web-team/eslint-config-browser\",\n    \"@hs-web-team/eslint-config-ts\"\n  ],\n}\n```\n\n## Further reading\n\nYou can find more information in our [Web Vendor Guidelines](https://docs.google.com/document/d/16cAeVe_XXgyRCo7R4Gw_Jy2D-nsUOE35UauoGMKv4CY/edit?usp=sharing) and [Web Technical Guidelines for Vendors](https://docs.google.com/document/d/16h_a-o4qggl40ojDqKePpatudmhvwWUNFzGcH4bL6c4/edit?usp=sharing).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhubspotwebteam%2Fcms-sample-project","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhubspotwebteam%2Fcms-sample-project","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhubspotwebteam%2Fcms-sample-project/lists"}