> For the complete documentation index, see [llms.txt](https://leftstick.gitbook.io/generator-umi/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://leftstick.gitbook.io/generator-umi/master.md).

# Getting Started

## generator-umi

[![](https://badge.fury.io/js/generator-umi.png)](https://npmjs.org/package/generator-umi) ![](https://david-dm.org/leftstick/generator-umi.png) ![](https://img.shields.io/npm/dt/generator-umi.svg) ![](https://img.shields.io/npm/l/generator-umi.svg)

Yeoman generator for umi project

![](/files/-LIAcZX5Xb_LNgWkCPFn)

## Installation

```bash
sudo npm install -g yo generator-umi
```

## Usage

### Create new umi app

```bash
yo umi
```

> answer questions `generator-umi` required

**Nice work,** now you get a playable project at <https://localhost:8000>, *username*/*password* is: *`admin@gmail.com`* / *`123456`*

### Start debugging

```bash
npm start
```

### Release with docker image

```bash
# create Docker Image
docker build --no-cache -t <imagename>:<version> .

# run docker image
docker run -p <exposed port>:3000 -e "STORAGE_DOMAIN=.yourdomain.com" -e "API_HOST=http://backend-address" -d <imagename>:<version>
```

### LICENSE

[MIT License](https://raw.githubusercontent.com/leftstick/generator-umi/master/LICENSE)