{"id":28403726,"url":"https://github.com/basemax/vuejs-cicd-deploy-on-github-pages","last_synced_at":"2026-04-12T17:01:45.091Z","repository":{"id":294621057,"uuid":"987527158","full_name":"BaseMax/vuejs-cicd-deploy-on-github-pages","owner":"BaseMax","description":"This project demonstrates how to set up a Vue 3 + Vite project using Bun or Node.js, with automated deployment to GitHub Pages using gh-pages package and GitHub Actions.","archived":false,"fork":false,"pushed_at":"2025-05-21T08:46:36.000Z","size":106,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-25T11:57:35.335Z","etag":null,"topics":["bun","cd","ci","ci-cd","cicd","deploy","github","github-action","github-actions","vite","vue","vuejs"],"latest_commit_sha":null,"homepage":"https://basemax.github.io/vuejs-cicd-deploy-on-github-pages/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BaseMax.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null}},"created_at":"2025-05-21T07:52:32.000Z","updated_at":"2025-05-21T09:02:26.000Z","dependencies_parsed_at":"2025-05-21T09:52:21.548Z","dependency_job_id":null,"html_url":"https://github.com/BaseMax/vuejs-cicd-deploy-on-github-pages","commit_stats":null,"previous_names":["basemax/vuejs-cicd-deploy-on-github-pages"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/BaseMax/vuejs-cicd-deploy-on-github-pages","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BaseMax%2Fvuejs-cicd-deploy-on-github-pages","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BaseMax%2Fvuejs-cicd-deploy-on-github-pages/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BaseMax%2Fvuejs-cicd-deploy-on-github-pages/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BaseMax%2Fvuejs-cicd-deploy-on-github-pages/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BaseMax","download_url":"https://codeload.github.com/BaseMax/vuejs-cicd-deploy-on-github-pages/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BaseMax%2Fvuejs-cicd-deploy-on-github-pages/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31722563,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-12T13:21:33.774Z","status":"ssl_error","status_checked_at":"2026-04-12T13:21:29.265Z","response_time":58,"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":["bun","cd","ci","ci-cd","cicd","deploy","github","github-action","github-actions","vite","vue","vuejs"],"created_at":"2025-06-01T19:08:39.470Z","updated_at":"2026-04-12T17:01:45.075Z","avatar_url":"https://github.com/BaseMax.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🚀 Vue.js CI/CD Deployment on GitHub Pages (via Node)\n\nThis project demonstrates how to set up a **Vue 3 + Vite** project using **Bun** or **Node.js**, with automated deployment to **GitHub Pages** using gh-pages package and GitHub Actions.\n\n\u003e 📡 **Live Demo:** [https://BaseMax.github.io/vuejs-cicd-deploy-on-github-pages](https://BaseMax.github.io/vuejs-cicd-deploy-on-github-pages)\n\n---\n\n## 📦 Tech Stack\n\n- ⚡ [Vue 3](https://vuejs.org/)\n- ⚗️ [Vite](https://vitejs.dev/)\n- 🧪 [Bun](https://bun.sh/) or [Node.js](https://nodejs.org/)\n- 🌀 GitHub Pages deploy script\n- 🛠 GitHub Actions CI/CD\n\n---\n\n## 🧪 Development\n\nRun locally with **Bun**:\n\n```bash\nbun install\nbun run dev\n```\n\nOr with npm:\n\n```bash\nnpm install\nnpm run dev\n```\n\n## 🚀 Deployment\n\nThis project uses a custom Node.js script to deploy the built app to the `gh-pages` branch.\n\n## ▶ Manual Deploy\n\n```bash\nnpm run deploy\n```\n\nThis runs deploy-gh-pages.mjs which:\n\n- Builds the project using vite build\n- Creates an orphan gh-pages branch\n- Commits the `dist/` folder\n- Force-pushes it to GitHub\n- Cleans up local state\n\n## ▶ GitHub Actions CI/CD\n\nAutomatic deployment is also set up via .github/workflows/deploy.yml. On every push to main, it:\n\n- Installs dependencies\n- Runs the deploy script (npm run deploy)\n- No manual steps are needed after a push to main.\n\n## 📁 Directory Structure\n\n```bash\n.\n├── .github/workflows/deploy.yml   # GitHub Actions CI/CD\n├── src/                           # Vue app source code\n├── dist/                          # Auto-generated after build\n├── index.html\n├── vite.config.ts\n└── package.json\n```\n\n## 🛠 Scripts in package.json\n\nFor your local machine:\n\n```json\n{\n  \"scripts\": {\n    \"dev\": \"vite\",\n    \"build\": \"vite build\",\n    \"preview\": \"vite preview\",\n    \"deploy\": \"vite build \u0026\u0026 gh-pages -d dist\"\n  }\n}\n```\n\nFor GitHub Actions:\n\n```json\n{\n  \"scripts\": {\n    \"dev\": \"vite\",\n    \"build\": \"vite build\",\n    \"preview\": \"vite preview\",\n    \"deploy\": \"vite build \u0026\u0026 gh-pages -d dist -u 'Max Base (Seyyed Ali Mohammadiyeh) \u003cmaxbasecode@gmail.com\u003e' -r https://x-access-token:${GITHUB_TOKEN}@github.com/BaseMax/vuejs-cicd-deploy-on-github-pages.git\"\n  }\n}\n```\n\n## 🔐 Notes\n\nMake sure GitHub Pages is enabled in repo settings:\n\n- Branch: `gh-pages`\n- Folder: `/` (root)\n\nThis repo is set to private: `\"private\": true` (optional for public sharing)\n\nYou need write access for pushing to `gh-pages`.\n\n## 👤 Author\n\nSeyyed Ali Mohammadiyeh (Max Base)\n\n📬 maxbasecode@gmail.com\n\n🔗 https://github.com/BaseMax\n\n## 🪪 License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbasemax%2Fvuejs-cicd-deploy-on-github-pages","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbasemax%2Fvuejs-cicd-deploy-on-github-pages","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbasemax%2Fvuejs-cicd-deploy-on-github-pages/lists"}