{"id":19335710,"url":"https://github.com/buttercms/hugo-starter-buttercms","last_synced_at":"2025-08-01T05:07:11.884Z","repository":{"id":59181288,"uuid":"515992949","full_name":"ButterCMS/hugo-starter-buttercms","owner":"ButterCMS","description":"Drop-in proof-of-concept Hugo app, fully integrated with your ButterCMS account","archived":false,"fork":false,"pushed_at":"2025-06-19T13:48:04.000Z","size":778,"stargazers_count":5,"open_issues_count":0,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-07-29T14:40:22.159Z","etag":null,"topics":["blog","buttercms","cms","go","hugo","netlify","starter-framework","starter-project"],"latest_commit_sha":null,"homepage":"https://hugo-starter-buttercms.netlify.app/","language":"SCSS","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/ButterCMS.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":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-07-20T13:27:14.000Z","updated_at":"2025-06-19T13:47:41.000Z","dependencies_parsed_at":"2024-06-21T01:07:31.773Z","dependency_job_id":"53fcc6f6-07a4-45cf-8bd1-22080b8a3987","html_url":"https://github.com/ButterCMS/hugo-starter-buttercms","commit_stats":{"total_commits":92,"total_committers":5,"mean_commits":18.4,"dds":0.2065217391304348,"last_synced_commit":"1c64e50d7d18a74773dc28da0309d5e4898979dc"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/ButterCMS/hugo-starter-buttercms","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ButterCMS%2Fhugo-starter-buttercms","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ButterCMS%2Fhugo-starter-buttercms/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ButterCMS%2Fhugo-starter-buttercms/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ButterCMS%2Fhugo-starter-buttercms/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ButterCMS","download_url":"https://codeload.github.com/ButterCMS/hugo-starter-buttercms/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ButterCMS%2Fhugo-starter-buttercms/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268171959,"owners_count":24207437,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-01T02:00:08.611Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["blog","buttercms","cms","go","hugo","netlify","starter-framework","starter-project"],"created_at":"2024-11-10T03:08:33.472Z","updated_at":"2025-08-01T05:07:11.875Z","avatar_url":"https://github.com/ButterCMS.png","language":"SCSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hugo + ButterCMS Starter Project\n\nLive demo: [https://hugo-starter-buttercms.netlify.app/](https://hugo-starter-buttercms.netlify.app/) \n\nThis Hugo starter project fully integrates with dynamic sample content from your ButterCMS account, including main menu, pages, blog posts, categories, and tags, and all with a beautiful, custom theme. All of the included sample content is automatically created in your account dashboard when you \n[sign up for a free trial](https://buttercms.com/join/) of ButterCMS.\n\n[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/ButterCMS/hugo-starter-buttercms#BUTTERCMS_API_TOKEN=Your_ButterCMS_Token_Here\u0026BUTTERCMS_PREVIEW=false)\n\n\n## Installation\n\nFirst, install the required dependencies:\n\n### Installing Go (1.22 or higher)\n\n**Ubuntu/Debian:**\n```bash\n$ sudo apt update\n$ sudo apt install golang-go\n\n**macOS (using Homebrew):**\n```bash\n$ brew install go\n```\n\n#### Windows\nFollow instructions from [the official website](https://go.dev/doc/install).\n\n### Installing Hugo (0.120.4 or higher)\n\n**Ubuntu/Debian:**\n```bash\n$ sudo apt update\n$ sudo apt install hugo\n```\n\n**macOS (using Homebrew):**\n```bash\n$ brew install hugo\n```\n\n#### Windows\nFollow instructions from [the official website](https://gohugo.io/installation/windows/).\n\n### Setting up the project\n\nClone the repository and download dependencies:\n\n```bash\n$ git clone https://github.com/ButterCMS/hugo-starter-buttercms.git\n$ cd hugo-starter-buttercms\n$ go mod download \n```\n\n### Set ButterCMS API Token\n\nTo fetch your ButterCMS content, add your API token as an environment variable. \n\n```bash\n$ echo 'BUTTERCMS_API_TOKEN=your_token' \u003e\u003e .env\n```\n\n### Fetch Data from ButterCMS\n\nTo fetch your ButterCMS content run:\n\n```bash\n$ go run github.com/ButterCMS/hugo-starter-buttercms/prebuild\n```\n\n*Because Hugo is a static site generator, you'll need to run this command for if you make changes to your Butter content and want to pull it into your app. For this reason, we recommend tapping into our webhook architecture, which will allow you to set up your deployed project to automatically show draft changes.*\n\n### Run Hugo Local Development Server\n\nTo view the app in the browser, you'll need to run the local development server:\n\n```bash\n$ hugo server\n```\n\nCongratulations! Your starter project is now live at: [http://localhost:1313/](http://localhost:1313/)\n\n### Deploy on Netlify\n\nOur starter app can be deployed to Netlify with the click of a button:\n\n1. Create a Heroku account at https://app.netlify.com.\n2. Click the button below and fill in an app name. Then click \"Deploy to Netlify\".\n\n[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/ButterCMS/hugo-starter-buttercms#BUTTERCMS_API_TOKEN=Your_ButterCMS_Token_Here\u0026BUTTERCMS_PREVIEW=false)\n\n### Webhooks\n\nIn order for your deployed app to pull in content changes from your ButterCMS account, you'll need to follow your hosting provider's steps for setting up webhooks. The ButterCMS webhook settings are located at https://buttercms.com/webhooks/. \n\n### Previewing Draft Changes\n\nBy default, your starter project is set up to allow previewing of draft changes saved in your ButterCMS.com account. To disable this functionality, set the following value in your **.env** file: `BUTTERCMS_PREVIEW=false`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbuttercms%2Fhugo-starter-buttercms","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbuttercms%2Fhugo-starter-buttercms","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbuttercms%2Fhugo-starter-buttercms/lists"}