# ngx-gh

> Deployment from the Angular CLI to GitHub pages

Latest version **0.0.2** (published 2019-07-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install ngx-gh
pnpm add ngx-gh
yarn add ngx-gh
bun add ngx-gh
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2019-07-17 |
| First published | 2019-07-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 19.9 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Minko Gechev |
| Maintainers | mgechev |
| Keywords | angular, cli, angular-cli, ghpages, github, pages, deploy, ng deploy, ng-deploy |

## Links

- npm: https://www.npmjs.com/package/ngx-gh
- Repository: https://github.com/mgechev/ng-deploy-gh-pages
- Homepage: https://github.com/mgechev/ng-deploy-gh-pages#readme
- Issues: https://github.com/mgechev/ng-deploy-gh-pages/issues
- npm.io page: https://npm.io/package/ngx-gh

## Dependencies (1)

- [gh-pages](https://npm.io/package/gh-pages.md) ^2.0.1

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.0.2 (latest) — 2019-07-17
- 0.0.1 — 2019-07-09
- 0.0.0 — 2019-07-09

## README

# Angular CLI Deployment to GitHub Pages

Deploy your Angular app to GitHub pages directly from the Angular CLI! 🚀

## How to use?

```
ng add ngx-gh
ng run [PROJECT_NAME]:deploy
```

## Options

If you're deploying your application to `https://[USERNAME].github.io/[PROJECT_NAME]`, you'd have to set the following options:

- `--deployUrl` - specifies the URL you're deploying your application to. For example `https://mgechev.github.io/codelyzer/`.
- `--baseHref` - specifies the `baseHref` and used by the Angular router. For the example above, the `baseHref` would be `/codelyzer/`.

Sample invocation:

```
ng run codelyzer:deploy --baseHref /codelyzer/
```

In Angular CLI 8.2.0, the command would be:

```
ng deploy --baseHref /codelyzer/
```

Deployment to the root of a custom domain may not require any of the listed flags below.

## Configuring the build

Since `ng deploy` will automatically invoke the production build of your app, you can configure it using the workspace configuration file `angular.json`. You can find the build config under: `projects.[PROJECT_NAME].architect.build.configuration.production`.

## License

MIT

---
_Source: https://npm.io/package/ngx-gh · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._