Skip to content
Snippets Groups Projects
README.md 2.51 KiB
Newer Older
Seth Ladd's avatar
Seth Ladd committed
# Stagehand - A Dart project generator
Seth Ladd's avatar
Seth Ladd committed

![Stagehand banner](https://raw.githubusercontent.com/dart-lang/stagehand/master/site/banner_stagehand.jpg)
Seth Ladd's avatar
Seth Ladd committed

[![Pub package](https://img.shields.io/pub/v/stagehand.svg)](https://pub.dev/packages/stagehand)
Kathy Walrath's avatar
Kathy Walrath committed
[![Build status](https://travis-ci.org/dart-lang/stagehand.svg?branch=master)](https://travis-ci.org/dart-lang/stagehand)
[![Coverage status](https://coveralls.io/repos/dart-lang/stagehand/badge.svg?branch=master)](https://coveralls.io/r/dart-lang/stagehand?branch=master)
Devon Carew's avatar
Devon Carew committed

Kathy Walrath's avatar
Kathy Walrath committed
## Helps you get set up!
Seth Ladd's avatar
Seth Ladd committed

Stagehand helps you get your Dart projects set up and ready for the big show.
Kathy Walrath's avatar
Kathy Walrath committed
It's a Dart project scaffolding generator, inspired by tools like Web Starter
Kathy Walrath's avatar
Kathy Walrath committed
Dart-savvy IDEs and editors use Stagehand behind the scenes to get project templates,
but you can also use Stagehand on the command line (`stagehand`).

## Stagehand templates
* `console-full` - A command-line application sample.
* `package-simple` - A starting point for Dart libraries or applications.
Devon Carew's avatar
Devon Carew committed
* `server-shelf` - A web server built using the shelf package.
* `web-angular` - A web app with material design components.
* `web-simple` - A web app that uses only core Dart libraries.
* `web-stagexl` - A starting point for 2D animation and games.
Kathy Walrath's avatar
Kathy Walrath committed
If you want to use Stagehand on the command line,
install it using `pub global activate`:
```console
> pub global activate stagehand
```
Kathy Walrath's avatar
Kathy Walrath committed
To update Stagehand, use the same `pub global activate` command.
Kathy Walrath's avatar
Kathy Walrath committed
Stagehand generates a project skeleton into the current directory.
For example, here's how you create a package with Stagehand:
```console
> mkdir fancy_project
> cd fancy_project
> stagehand package-simple
```
Kathy Walrath's avatar
Kathy Walrath committed
Here's how you list all of the project templates:
Seth Ladd's avatar
Seth Ladd committed
## Goals

* Opinionated and prescriptive; minimal to no options
* Support for server and client apps
* The best way to create a new Dart project
* Used by IntelliJ, WebStorm, Visual Studio Code, Atom, Sublime, and more
Seth Ladd's avatar
Seth Ladd committed
* Distributed as a pub package

## Issues and bugs

Devon Carew's avatar
Devon Carew committed
Please file reports on the
Kathy Walrath's avatar
Kathy Walrath committed
[GitHub issue tracker](https://github.com/dart-lang/stagehand/issues).
Seth Ladd's avatar
Seth Ladd committed

Devon Carew's avatar
Devon Carew committed
## Contributing

Devon Carew's avatar
Devon Carew committed
Contributions welcome! Please read this short
[guide](https://github.com/dart-lang/stagehand/blob/master/CONTRIBUTING.md) first.
Devon Carew's avatar
Devon Carew committed

Seth Ladd's avatar
Seth Ladd committed
## Analytics and crash reports

Devon Carew's avatar
Devon Carew committed
Learn more about how [Stagehand uses Google Analytics][analytics] for measuring
usage and error reporting, and how you can opt out.
Seth Ladd's avatar
Seth Ladd committed

[analytics]: https://github.com/dart-lang/stagehand/wiki/Anonymous-analytics-and-crash-reports