# generator-coracle

> generator for coracle

Latest version **1.1.7** (published 2015-12-03) · GPL license · 0 weekly downloads

## Install

```sh
npm install generator-coracle
pnpm add generator-coracle
yarn add generator-coracle
bun add generator-coracle
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.7 |
| Published | 2015-12-03 |
| First published | 2015-11-23 |
| Weekly downloads | 0 |
| License | GPL |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | renian |
| Maintainers | renjian, umin, yangriwang |
| Keywords | yeoman-generator, coracle |

## Links

- npm: https://www.npmjs.com/package/generator-coracle
- npm.io page: https://npm.io/package/generator-coracle

## Dependencies (1)

- [yeoman-generator](https://npm.io/package/yeoman-generator.md) ^0.20.2

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 1.1.7 (latest) — 2015-12-03
- 1.1.6 — 2015-12-02
- 1.1.5 — 2015-12-02
- 1.1.4 — 2015-12-02
- 1.1.3 — 2015-12-01
- 1.1.2 — 2015-11-25
- 1.1.1 — 2015-11-24
- 1.1.0 — 2015-11-23
- 1.0.7 — 2015-11-23
- 1.0.6 — 2015-11-23
- 1.0.5 — 2015-11-23
- 1.0.4 — 2015-11-23
- 1.0.3 — 2015-11-23
- 1.0.2 — 2015-11-23
- 1.0.1 — 2015-11-23
- … 1 more at https://npm.io/package/generator-coracle/versions

## README

# Coracle generator

Scaffold a project in 1 minute

Some command maybe need authority, please use `sudo`.

## Install

```bash
npm install -g yo gulp generator-coracle
```

## Usage

### 1. Create the project directory


```bash
mkdir my_app
```

### 2. Run the generator

```bash
cd my_app
yo coracle
```

Be patient.. this may take a few minutes.
If throw some Error when install npm package,you can do it by yourself:

```bash
npm install
```

### 3. config

write config.js for your project

### 4. Build

```bash
gulp build
```

### 5. Run your app

Start a development web server, start Weinre, and watch for changes

``` bash
gulp
```
`gulp build` will auto run when use this task,and watch file to livereload.

### 6. zip your app

Conpress zip files for your project module

``` bash
gulp zip
```

### 7. upload your module to xSimple

``` bash
gulp upload
```
use `up` or `down` move,`space` to select,`enter` to commit.

## warning

Every module should have a `.js`,`.html`,`.css`,`.less` file.Otherwise `gulp build` will not make a folder for this module.Then `gulp upload` will throw a error.

## License

GPL



＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝中文文档＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝
# Coracle generator

一分钟构建项目

一些命令可能需要权限请使用`sudo`.

##  安装指令

```bash
npm install -g yo gulp generator-coracle
```

## 用户操作
### 创建一个目录 
指令

```bash
mkdir my_app
```

### 运行自定义yeoman模板
指令

```bash
cd my_app
yo coracle
```

需要一点时间等待安装成功！
如果安装npm依赖包时报错，你可以自己手动安装

```bash
npm install
```

### 3. 配置

config.js 为项目的配置文件

### 4.构建初始化 
指令

```bash
gulp build
```

### 5. 发布 运行 app 目录下的web文件
默认使用本地ip 端口默认8000
指令

``` bash
gulp
```
`gulp build` 回在执行这个任务前自动调用.同时监视本地文件变化自动同步刷新页面。

### 6. 压缩发布的app目录的文件夹
指令


``` bash
gulp zip
```

### 7. 对应模块上传 xSimple
指令

``` bash
gulp upload
```
键盘上下选择模块 按空格表示是否选中 回车提交上传。

## 温馨提醒

每个模块中必须至少包含一个html，css，less，或者js 文件，否则`gulp build` 会生成一个空目录，`gulp upload`会报错。
请按顺序操作 `gulp build` 先构建 才能使用 `gulp upload` 否则上传会找不到文件报错！

## 协议

GPL

---
_Source: https://npm.io/package/generator-coracle · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._