{"id":19335716,"url":"https://github.com/buttercms/nuxtjs-starter-buttercms","last_synced_at":"2025-04-23T00:32:08.808Z","repository":{"id":38453577,"uuid":"480806217","full_name":"ButterCMS/nuxtjs-starter-buttercms","owner":"ButterCMS","description":"Drop-in proof-of-concept Nuxt.JS, fully integrated with your ButterCMS account","archived":false,"fork":false,"pushed_at":"2025-04-15T11:27:46.000Z","size":1467,"stargazers_count":0,"open_issues_count":0,"forks_count":5,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-20T23:04:22.527Z","etag":null,"topics":["butter","buttercms","cms","nuxt","nuxtjs","starter-project","vercel"],"latest_commit_sha":null,"homepage":"https://nuxtjs-starter-buttercms.vercel.app","language":"Vue","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}},"created_at":"2022-04-12T12:44:00.000Z","updated_at":"2025-04-15T11:25:58.000Z","dependencies_parsed_at":"2023-11-10T01:47:08.152Z","dependency_job_id":"f2f5099a-9f74-4a68-bc28-47fecc1985a4","html_url":"https://github.com/ButterCMS/nuxtjs-starter-buttercms","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ButterCMS%2Fnuxtjs-starter-buttercms","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ButterCMS%2Fnuxtjs-starter-buttercms/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ButterCMS%2Fnuxtjs-starter-buttercms/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ButterCMS%2Fnuxtjs-starter-buttercms/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ButterCMS","download_url":"https://codeload.github.com/ButterCMS/nuxtjs-starter-buttercms/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250348327,"owners_count":21415894,"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","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":["butter","buttercms","cms","nuxt","nuxtjs","starter-project","vercel"],"created_at":"2024-11-10T03:08:35.388Z","updated_at":"2025-04-23T00:32:08.757Z","avatar_url":"https://github.com/ButterCMS.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"![recommended node version](https://img.shields.io/badge/node-v22-green)\n\n# Nuxt.js + ButterCMS Starter Project\n\nThis Nuxt.js starter project fully integrates with dynamic sample content from your ButterCMS account, including main menu, pages, blog posts, categories, and tags, all with a beautiful, custom theme with already-implemented search functionality. All of the included sample content is automatically created in your account dashboard when you sign up for a free trial of ButterCMS.\n\nYou can view a [live demo hosted on Vercel](http://nuxtjs-starter-buttercms.vercel.app/), or you can click the button below to deploy your own copy of our starter project to the provider of your choice.\n\n[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FButterCMS%2Fnuxtjs-starter-buttercms\u0026env=NUXT_ENV_BUTTER_API_TOKEN\u0026envDescription=Your%20ButterCMS%20API%20Token\u0026envLink=https%3A%2F%2Fbuttercms.com%2Fsettings%2F\u0026project-name=nuxtjs-starter-buttercms\u0026repo-name=nuxtjs-starter-buttercms\u0026redirect-url=https%3A%2F%2Fbuttercms.com%2Fonboarding%2Fvercel-starter-deploy-callback%2F\u0026production-deploy-hook=Deploy%20Triggered%20from%20ButterCMS\u0026demo-title=ButterCMS%20Nuxt.js%20Starter%20Demo\u0026demo-description=Fully%20integrated%20with%20your%20ButterCMS%20account\u0026demo-url=http%3A%2F%2Fnuxtjs-starter-buttercms.vercel.app%2F\u0026repository-name=nuxtjs-starter-buttercms\u0026demo-image=https://cdn.buttercms.com/r0tGK8xFRti2iRKBJ0eY)\n[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/ButterCMS/nuxtjs-starter-buttercms\u0026env%NUXT_ENV_BUTTER_API_TOKEN%5D=check%20https://buttercms.com/settings)\n\n## 1. Installation\n\nFirst, clone the repo and install the dependencies by running `npm install`\n```shell\ngit clone https://github.com/ButterCMS/nuxtjs-starter-buttercms\ncd nuxtjs-starter-buttercms\nnpm install\n```\n\n### 2. Set API Token\n\nTo fetch your ButterCMS content, add your API token as an environment variable.\n\n```bash\n$ echo 'NUXT_ENV_BUTTER_API_TOKEN=\u003cYour API Token\u003e' \u003e\u003e .env\n```\n\n### 3. Run local server\n\nTo view the app in the browser, you'll need to run the local development server:\n\n```bash\n$ npm run dev\n```\n\nCongratulations! Your starter project is now live at [http://localhost:3000/](http://localhost:3000/).\n\n## 4. Deploy\nDeploy your Nuxt.js app using Vercel, the creators of Next.js, or with Heroku. With the click of a button, you'll create a copy of our starter project in your Git provider account, instantly deploy it, and institute a full content workflow connected to your ButterCMS account. Smooth.\n\n[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FButterCMS%2Fnuxtjs-starter-buttercms\u0026env=NUXT_ENV_BUTTER_API_TOKEN\u0026envDescription=Your%20ButterCMS%20API%20Token\u0026envLink=https%3A%2F%2Fbuttercms.com%2Fsettings%2F\u0026project-name=nuxtjs-starter-buttercms\u0026repo-name=nuxtjs-starter-buttercms\u0026redirect-url=https%3A%2F%2Fbuttercms.com%2Fonboarding%2Fvercel-starter-deploy-callback%2F\u0026production-deploy-hook=Deploy%20Triggered%20from%20ButterCMS\u0026demo-title=ButterCMS%20Nuxt.js%20Starter%20Demo\u0026demo-description=Fully%20integrated%20with%20your%20ButterCMS%20account\u0026demo-url=http%3A%2F%2Fnuxtjs-starter-buttercms.vercel.app%2F\u0026repository-name=nuxtjs-starter-buttercms\u0026demo-image=https://cdn.buttercms.com/r0tGK8xFRti2iRKBJ0eY)\n[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/ButterCMS/nuxtjs-starter-buttercms\u0026env%NUXT_ENV_BUTTER_API_TOKEN%5D=check%20https://buttercms.com/settings)\n\n## 5. Previewing Draft Changes\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: NUXT_ENV_BUTTER_PREVIEW=false\n\n## 6. Project Dependencies\n\nThe project uses the following key dependencies:\n\n- **Nuxt**: ^3.16.2 - Modern, performant Vue framework\n- **Vue**: ^3.5.13 - Progressive JavaScript framework\n- **ButterCMS**: ^3.0.1 - Headless CMS\n- **tiny-slider**: ^2.9.4 - Lightweight slider library\n\n### Node.js Compatibility\n\nThis project requires Node.js v22 or newer.\n\n## 7. TypeScript Support\n\nTypeScript is supported in this project through Nuxt's built-in TypeScript integration. A custom type declaration file (`nuxt-types.d.ts`) provides type hints for Nuxt's auto-imported composables.\n\n## 8. Development Notes\n\n- The project uses Nuxt 3's auto-import feature for composables (useRoute, useRouter, etc.)\n- Compatibility date is set to ensure consistent behavior across different Nuxt versions\n- ButterCMS integration is configured in `plugins/ButterCMS.ts`\n\n## 9. Versioning\n\nThis project follows [Semantic Versioning](https://semver.org/) (SemVer). The current version is 2.0.0.\n\nVersioning information is maintained in multiple places:\n- `package.json` - Contains the current version number\n- `CHANGELOG.md` - Documents changes between versions\n- Git tags - Each release is tagged with its version number\n- `nuxt.config.ts` - Exports APP_VERSION constant and makes it available via runtimeConfig\n\nTo access the version in your components:\n```js\nconst config = useRuntimeConfig();\nconsole.log(config.public.APP_VERSION); // \"2.0.0\"\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbuttercms%2Fnuxtjs-starter-buttercms","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbuttercms%2Fnuxtjs-starter-buttercms","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbuttercms%2Fnuxtjs-starter-buttercms/lists"}