{"id":16439312,"url":"https://github.com/jeneser/vue-cli-ghpages","last_synced_at":"2026-02-11T06:34:26.521Z","repository":{"id":57394963,"uuid":"99699620","full_name":"jeneser/vue-cli-ghpages","owner":"jeneser","description":"Made for vue-cli users. Publish to any gh-pages branch on GitHub. The Single-Page App Hack for GitHub Pages.","archived":false,"fork":false,"pushed_at":"2017-08-24T11:27:11.000Z","size":113,"stargazers_count":25,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-05T18:16:03.357Z","etag":null,"topics":["gh-pages","github-pages","vue","vue-cli","vue-cli-ghpages","vuejs"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/vue-cli-ghpages","language":"JavaScript","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/jeneser.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}},"created_at":"2017-08-08T14:05:23.000Z","updated_at":"2021-01-22T19:46:22.000Z","dependencies_parsed_at":"2022-09-06T02:50:10.405Z","dependency_job_id":null,"html_url":"https://github.com/jeneser/vue-cli-ghpages","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/jeneser/vue-cli-ghpages","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeneser%2Fvue-cli-ghpages","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeneser%2Fvue-cli-ghpages/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeneser%2Fvue-cli-ghpages/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeneser%2Fvue-cli-ghpages/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jeneser","download_url":"https://codeload.github.com/jeneser/vue-cli-ghpages/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeneser%2Fvue-cli-ghpages/sbom","scorecard":{"id":514876,"data":{"date":"2025-08-11","repo":{"name":"github.com/jeneser/vue-cli-ghpages","commit":"606651211f6c65ba1699ffef1ad4b6b4e613795f"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Code-Review","score":0,"reason":"Found 0/14 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 2 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-20T01:33:49.549Z","repository_id":57394963,"created_at":"2025-08-20T01:33:49.549Z","updated_at":"2025-08-20T01:33:49.549Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29328261,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-11T06:13:03.264Z","status":"ssl_error","status_checked_at":"2026-02-11T06:12:55.843Z","response_time":97,"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":["gh-pages","github-pages","vue","vue-cli","vue-cli-ghpages","vuejs"],"created_at":"2024-10-11T09:08:52.283Z","updated_at":"2026-02-11T06:34:26.505Z","avatar_url":"https://github.com/jeneser.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"**DANGER: Hack code bug, wontfix!**\n\n\u003cp\u003e\n  \u003cimg src=\"logo.png\" alt=\"logo\"  width=\"150px\" height=\"150px\"/\u003e\n\u003c/p\u003e\n\n## vue-cli-ghpages\n\n[![npm version](https://badge.fury.io/js/vue-cli-ghpages.svg)](https://badge.fury.io/js/vue-cli-ghpages) [![David](https://img.shields.io/david/expressjs/express.svg?style=flat-square)](https://github.com/jeneser/vue-cli-ghpages) [![Percentage of issues still open](http://isitmaintained.com/badge/open/jeneser/vue-cli-ghpages.svg)](http://isitmaintained.com/project/jeneser/vue-cli-ghpages \"Percentage of issues still open\") [![PR](https://img.shields.io/badge/PR-welcome-brightgreen.svg)](https://github.com/jeneser/vue-cli-ghpages/pulls) [![license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/jeneser)\n\n[![NPM](https://nodei.co/npm/vue-cli-ghpages.png?downloads=true\u0026downloadRank=true\u0026stars=true)](https://nodei.co/npm/vue-cli-ghpages/)\n\nPublish to any `gh-pages` branch on GitHub. The Single-Page App [**Hack**](https://github.com/jeneser/vue-cli-ghpages/tree/master/src/hack) for GitHub Pages.\n\nA clean way of deploying vue-cli apps to [`github pages`](https://pages.github.com/).\n\nMade for [`vue-cli`](https://github.com/vuejs/vue-cli) users.\n\nMade on top of [tschaub/gh-pages](https://github.com/tschaub/gh-pages).\n\nInspired by [`angular-cli-ghpages`](https://github.com/angular-buch/angular-cli-ghpages) and [`spa-github-pages`](https://github.com/rafrex/spa-github-pages).\n\n\n## Quick start\n\nQuickly understand what `vue-cli-ghpages` has done.\n\n\u003cp\u003e\n  \u003cimg src=\"screenshot.gif\" alt=\"preview\"/\u003e\n\u003c/p\u003e\n\n## Installation\n\nThis command has the following prerequisites:\n\n- Node.js 6.x\n- Git 1.7.6 or higher\n- **optional:** Vue project created via [vue-cli](https://github.com/vuejs/vue-cli)\n\nTo install the command once globally run the following:\n\n```\n$ npm install -g vue-cli-ghpages\n```\n\n## Usage\n\nExecute `vue-cli-ghpages` in order to deploy the project with a build from `dist` folder.\n\n**Note: you have to create the dist folder in before (e.g. npm run build)**\n\nUsage:\n\n```\n$ npm run build\n$ vue-cli-ghpages [OPTIONS]\n```\n\nthere is also a shorter `vcg` command available\n\n```\n$ npm run build\n$ vcg [OPTIONS]\n```\n\n**Tip:** If you want to push to `gh-pages` on the same repository with your **default credentials**,  then just enter **`vcg`** without any options.\n\n## Options\n\n#### --help\n\n * Example: `vcg --help`\n\nOutput usage information.\n\n#### --version\n\n * Example: `vcg --version`\n\nOutput the version number.\n\n#### --message\n\n * **[optional]**\n * Default: `Vcg: Update live demo`\n * Example: `vcg --message=\"Update live demo\"`\n\nThe commit message, **must be wrapped in quotes**.\n\n#### --branch\n\n * **[optional]**\n * Default: `gh-pages`\n * Example: `vcg --branch=other-branch`\n\nThe name of the branch you'll be pushing to.\nThe default uses GitHub's `gh-pages` branch,\nbut this can be configured to push to any branch on any remote.\n\n#### --name \u0026 --email\n\n * **[optional]**\n * Default: value of `git config user.name` and `git config user.email`\n * Example: `vcg --name=\"Displayed Username\" --email=mail@example.org`\n\nIf you are running the command in a repository without a `user.name` or `user.email` git config properties\n(or on a machine **without** these global config properties),\nyou **must** provide user info before git allows you to commit.\nIn this case provide both `name` and `email` string values to identify the committer.\n\n#### --repo\n\n * **[optional]**\n * Default: url of the origin remote of the current dir (assumes a git repository)\n * Example: `vcg --repo=https://example.com/other/repo.git`\n\nBy default, [**gh-pages**](https://github.com/tschaub/gh-pages) assumes that the current working directory is a git repository,\nand that you want to push changes to the `origin` remote.\nIf instead your files are not in a git repository, or if you want to push to another repository,\nyou can provide the repository URL in the `repo` option.\n\n#### --dir\n\n * **[optional]**\n * Default: `dist`\n\nDirectory for all published sources, relative to the project-root.\nMost probably no change is required here.\nThis option can be used to deploy completely different folders,\nwhich are not related at all to Vue.\n\n#### --CNAME\n\n * **[optional]**\n * Default: ''\n * Example: `vcg --CNAME=example.io`\n\nSet up a custom domain.\nsee GitHub Pages instructions for [setting up a custom domain](https://help.github.com/articles/quick-start-setting-up-a-custom-domain/).\n\n#### --pre-deploy*\n * **[optional]**\n * Default: `undefined`\n * Example: `vcg --pre-deploy`\n\n**Take care** the flag. Upcoming...\n`*` Check the environment and configuration. Run through without publishing.\n\n## Why vue-cli-ghpages?\n\n**If you’re getting started** with Vue, use `vue-cli` to scaffolding Vue.js projects. **Then, host** `Vue app`(single page apps) with [`github pages`](https://pages.github.com/).\n\n* You don’t need to install or configure tools like [`gh-pages`](https://github.com/tschaub/gh-pages).\n\n* You don’t need to waste time Hacking for GitHub Pages.\n\n* You don’t even need to learning git.\n\nThey are preconfigured and hidden so that you can focus on your code.\n\n*Just run `vcg`, and you’re good to go.*\n\n\u003eWhy it's necessary?\n\u003e\n\u003eGitHub Pages doesn't natively support single page apps. When there is a fresh page load for a url like example.tld/foo, where /foo is a frontend route, the GitHub Pages server returns 404 because it knows nothing of /foo. we need Hacking for GitHub Pages.\n\n*Learn more:*\n\n[My hack.json](https://github.com/jeneser/vue-cli-ghpages/tree/master/src/hack) | [How it works?](https://github.com/rafrex/spa-github-pages#how-it-works) | [Usage instructions](https://github.com/rafrex/spa-github-pages#usage-instructions) | [Publish files to a gh-pages branch on GitHub](https://github.com/tschaub/gh-pages)\n\n## FAQ\n\n\u003cdetails\u003e\n\t\u003csummary\u003eWhy file path is broken and shows blank page on Github Pages?\u003c/summary\u003e\u003c/br\u003e\n\t\tAfter publish to gh-pages branch on GitHub. There is still nothing being displayed. File path is broken and shows blank page on Github Pages. Here are the console errors like: Get https://user.github.io/static/[css]|[js]/app.[hash].[css]|[js] 404 (Not Found)\u003cbr\u003e\n\t\tTo fix it simplely:\u003cbr\u003e\n\t\tOpen up /config/index.js, and find the following line. \u003cbr\u003e\n\t\tassetsPublicPath: '/'\u003cbr\u003e\n\t\t Just change the absolute path to a relative path.\u003cbr\u003e\n\t\tModify to assetsPublicPath: './' OR assetsPublicPath: 'https://[user].github.io/[project-name]/'\n\u003c/details\u003e\n\u003cdetails\u003e\n\t\u003csummary\u003eCan i use Vue-router HTML5 History Mode?\u003c/summary\u003e\u003cbr\u003e\n\tBeautiful, you can do it.\u003cbr\u003e\n\tSince our app is a single page client side app, without a proper server configuration, the users will get a 404 error if they access http://oursite.com/user/id directly in their browser. Now that's ugly.\u003cbr\u003e\n\tvue-cli-ghpages fixed the issue preconfigured and hidden. We hacked(catch-all fallback route to your server) it.\u003cbr\u003e\n\tIf the URL doesn't match any static assets, it should serve the same index.html page that your app lives in. Beautiful, again!\u003cbr\u003e\n\tLearn more: How-it-works? https://github.com/rafrex/spa-github-pages#how-it-works\n\u003c/details\u003e\n\u003cdetails\u003e\n\t\u003csummary\u003eWhere can I see my deployed github pages url?\u003c/summary\u003e\u003cbr\u003e\n\tGo to you repository settings, scroll down to the GitHub Pages section.\u003cbr\u003e\n\tYou will see: Your site is published at https://user.github.io/project/\u003cbr\u003e\n\u003c/details\u003e\n\u003cdetails\u003e\n\t\u003csummary\u003eMy CNAME file is deleted on every publish?\u003c/summary\u003e\u003cbr\u003e\n\tThat's by design, the command overrides everything. But, you just need to configure it once. It will make changes based on the existing configuration(CNAME) and flag(--CNAME).\u003cbr\u003e\n\tYou can also manually modify. (echo \"my-domain.com\" \u003e dist/CNAME)\u003cbr\u003e\n\u003c/details\u003e\n\n## Contributing\n\n1. Fork it!\n2. Create your feature branch: `git checkout -b my-new-feature`\n3. Commit your changes: `git commit -am 'Add some feature'`\n4. Push to the branch: `git push origin my-new-feature`\n5. Submit a pull request\n\n## Thanks\n\n[`angular-cli-ghpages`](https://github.com/angular-buch/angular-cli-ghpages)\n\n[`spa-github-pages`](https://github.com/rafrex/spa-github-pages)\n\n[`gh-pages`](https://github.com/tschaub/gh-pages)\n\n## License\n\n[MIT](https://github.com/jeneser/vue-cli-ghpages/blob/master/LICENSE) Copyright (c) 2017 [Jeneser](https://jeneser.github.io/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeneser%2Fvue-cli-ghpages","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjeneser%2Fvue-cli-ghpages","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeneser%2Fvue-cli-ghpages/lists"}