https://github.com/cjpatoilo/boeing

Deployment to GitHub Pages. Zero-configuration!
https://github.com/cjpatoilo/boeing

automation cli command-line-tool deployment gh-pages github-page nodejs shell

Last synced: 3 months ago
JSON representation

Deployment to GitHub Pages. Zero-configuration!

• Host: GitHub
• URL: https://github.com/cjpatoilo/boeing
• Owner: cjpatoilo
• License: mit
• Created: 2018-02-13T07:16:08.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2023-02-27T01:28:47.000Z (almost 2 years ago)
• Last Synced: 2024-10-20T07:35:41.244Z (3 months ago)
• Topics: automation, cli, command-line-tool, deployment, gh-pages, github-page, nodejs, shell
• Language: Shell
• Homepage: https://cjpatoilo.com/boeing
• Size: 605 KB
• Stars: 20
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Contributing: .github/contributing.md
  • Funding: .github/funding.yml
  • License: license

Awesome Lists containing this project

README

        


> Deployment to GitHub Pages.

[![Travis Status](https://travis-ci.org/cjpatoilo/boeing.svg?branch=master)](https://travis-ci.org/cjpatoilo/boeing?branch=master)

[![AppVeyor Status](https://ci.appveyor.com/api/projects/status/xqipsriuq9w0ygla?svg=true)](https://ci.appveyor.com/project/cjpatoilo/boeing)

[![Codacy Status](https://img.shields.io/codacy/grade/993946b7db91463c82d743590966b02b/master.svg)](https://www.codacy.com/app/cjpatoilo/boeing/dashboard)

[![Dependencies Status](https://david-dm.org/cjpatoilo/boeing/status.svg)](https://david-dm.org/cjpatoilo/boeing)

[![Version Status](https://badge.fury.io/js/boeing.svg)](https://www.npmjs.com/package/boeing)

[![Download Status](https://img.shields.io/npm/dt/boeing.svg)](https://www.npmjs.com/package/boeing)

[![Gitter Chat](https://img.shields.io/badge/gitter-join_the_chat-4cc61e.svg)](https://gitter.im/cjpatoilo/boeing)

## Why it's awesome

Boeing provides an automated setup for a faster and secure deployment to GitHub Pages. Hope you enjoy!

## Getting Started

**Install with npm**

```sh

$ npm i -g boeing

```

**Install with Yarn**

```sh

$ yarn global add boeing

```

**Run with npx (without installing)**

```sh

$ npx boeing

```

Note: Install as a `global` tool or as `devDependencies`.

## Usage

```

$ boeing --help

  Usage:

    boeing  []

  Options:

    -h, --help              Display help information about Boeing

    -v, --version           Output Bower version

  Examples:

    boeing dist

```

## Contributing

Want to contribute? Follow these [recommendations](https://github.com/cjpatoilo/boeing/contribute).

## License

Designed with ♥ by [CJ Patoilo](https://twitter.com/cjpatoilo). Licensed under the [MIT License](https://cjpatoilo.com/license).