https://github.com/phaser-cli/phaser-cli

Create Phaser projects with no build configuration.
https://github.com/phaser-cli/phaser-cli

build-tools phaser zero-configuration

Last synced: 3 months ago
JSON representation

Create Phaser projects with no build configuration.

• Host: GitHub
• URL: https://github.com/phaser-cli/phaser-cli
• Owner: phaser-cli
• License: mit
• Created: 2017-04-01T04:12:12.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2020-01-12T20:48:55.000Z (about 5 years ago)
• Last Synced: 2024-10-26T13:11:41.837Z (3 months ago)
• Topics: build-tools, phaser, zero-configuration
• Language: JavaScript
• Homepage:
• Size: 829 KB
• Stars: 56
• Watchers: 8
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Phaser CLI

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

[![Build Status](https://travis-ci.org/phaser-cli/phaser-cli.svg?branch=master)](https://travis-ci.org/phaser-cli/phaser-cli)

Create Phaser projects with no build configuration.

## Getting Started

### Prerequisites

In order to use Phaser CLI you need to have [Node.js][1] (>= 6) installed.

### Quickstart

Run the following commands to install Phaser CLI and create a new project. This

will create a new folder matching the specified `project-name` and will generate

all the required files.

Currently the only boilerplate available to use is TypeScript, but this may

change in the future.

```bash

npm install -g @phaser-cli/cli

# or

yarn global add @phaser-cli/cli

phaser create 

```

### Running in Development

Running the following command will serve your project to [localhost:8080][2].

```bash

npm start

```

If you wish to change the host or the port of the dev server you can prepend the

command with `HOST=127.0.0.1` or `PORT=3000`, replacing the example values with

your own.

### Building for Production

The following command will build your game for production, bundling code and

assets into the `/build` directory.

```bash

npm run build

```

## Ejecting

You also have the option to eject from phaser-cli allowing you to customise

webpack and other config to your heart's content. This is not recommended unless

you really need to change something.

_Note: You will no longer receive updates through the @phaser-cli/scripts

package if you choose to eject._

```

npm run eject

```

## Acknowledgements

Phaser CLI is based on [Create React App][3] by Facebook and [vue-cli][4] by

Evan You.

[Phaser][5] is created by [Richard Davey][6].

[1]: https://nodejs.org

[2]: http://localhost:8080

[3]: https://github.com/facebook/create-react-app

[4]: https://github.com/vuejs/vue-cli

[5]: https://github.com/photonstorm/phaser

[6]: https://twitter.com/photonstorm