# Create Probot App

[![CI](https://github.com/probot/create-probot-app/workflows/Test/badge.svg)](https://github.com/probot/create-probot-app/actions)

`create-probot-app` is a _command line_ (CLI) Node.js application that generates a new [Probot](https://github.com/probot/probot) app with everything you need to get started building. 👷🏽‍

More specifically, this command line interface allows you to select from our pre-defined blueprints to choose a basic working example to start from.

## Installation

Make sure you've got [Node.js installed](https://Node.js.org/en/download/) on your workstation, then open your terminal and type the following command:

- if you're using `npm` (the package manager bundled with `Node.js`):

  ```sh
  npx create-probot-app my-first-app
  ```

- if you're using Yarn:

  ```sh
  yarn create probot-app my-first-app
  ```

and follow the instructions printed on the terminal as you go. `create-probot-app` will then take care of the heavy lifting required to setup a Probot app development environment, with proper folder structure, and even installing all the basic `Probot` dependencies.

## How to run locally

See the [Probot docs](https://probot.github.io/docs/development/#running-the-app-locally) to get started running your app locally.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tr>
    <td align="center"><a href="https://create-nom.app"><img src="https://avatars3.githubusercontent.com/u/10104630?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Maxim Devoir</b></sub></a><br /><a href="https://github.com/probot/create-probot-app/commits?author=MaximDevoir" title="Code">💻</a> <a href="https://github.com/probot/create-probot-app/pulls?q=is%3Apr+reviewed-by%3AMaximDevoir" title="Reviewed Pull Requests">👀</a></td>
    <td align="center"><a href="https://a.l3x.in/"><img src="https://avatars1.githubusercontent.com/u/281389?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Alexander Fortin</b></sub></a><br /><a href="https://github.com/probot/create-probot-app/commits?author=shaftoe" title="Code">💻</a></td>
    <td align="center"><a href="http://hiimbex.com"><img src="https://avatars1.githubusercontent.com/u/13410355?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Bex Warner</b></sub></a><br /><a href="https://github.com/probot/create-probot-app/commits?author=hiimbex" title="Code">💻</a> <a href="https://github.com/probot/create-probot-app/pulls?q=is%3Apr+reviewed-by%3Ahiimbex" title="Reviewed Pull Requests">👀</a></td>
    <td align="center"><a href="https://github.com/tcbyrd"><img src="https://avatars0.githubusercontent.com/u/13207348?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Tommy Byrd</b></sub></a><br /><a href="https://github.com/probot/create-probot-app/commits?author=tcbyrd" title="Code">💻</a></td>
    <td align="center"><a href="https://jasonet.co"><img src="https://avatars1.githubusercontent.com/u/10660468?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jason Etcovitch</b></sub></a><br /><a href="https://github.com/probot/create-probot-app/commits?author=JasonEtco" title="Code">💻</a></td>
  </tr>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!