# logoran-demo

> [![npm version](https://badge.fury.io/js/logoran-demo.svg)](http://badge.fury.io/js/logoran-demo) [![Build](https://travis-ci.org/logoran/logoran-demo.svg?branch=master)](https://travis-ci.org/logoran/logoran-demo)

Latest version **1.0.3** (published 2018-03-31) · 0 weekly downloads

## Install

```sh
npm install logoran-demo
pnpm add logoran-demo
yarn add logoran-demo
bun add logoran-demo
```

## 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.0.3 |
| Published | 2018-03-31 |
| First published | 2018-03-09 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 10 |
| Unpacked size | 156.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | leo18 |

## Links

- npm: https://www.npmjs.com/package/logoran-demo
- npm.io page: https://npm.io/package/logoran-demo

## Dependencies (10)

- [jade](https://npm.io/package/jade.md) ~1.11.0
- [debug](https://npm.io/package/debug.md) ^2.6.3
- [config](https://npm.io/package/config.md) ^1.30.0
- [dotenv](https://npm.io/package/dotenv.md) ^5.0.1
- [logoran](https://npm.io/package/logoran.md) ^1.0.1
- [koa-body](https://npm.io/package/koa-body.md) ^2.5.0
- [koa-views](https://npm.io/package/koa-views.md) ^5.2.1
- [koa-static](https://npm.io/package/koa-static.md) ^4.0.2
- [logoran-logger](https://npm.io/package/logoran-logger.md) ^1.0.1
- [logoran-router](https://npm.io/package/logoran-router.md) ^1.0.2

## Recent versions

- 1.0.3 (latest) — 2018-03-31
- 1.0.2 — 2018-03-30
- 1.0.1 — 2018-03-30
- 1.0.0 — 2018-03-09
- 0.1.0 — 2018-03-09

## README

# logoran-demo

[![npm version](https://badge.fury.io/js/logoran-demo.svg)](http://badge.fury.io/js/logoran-demo)
[![Build](https://travis-ci.org/logoran/logoran-demo.svg?branch=master)](https://travis-ci.org/logoran/logoran-demo)



这个项目是express风格的最新的Logoran项目的示例，已集成到[logoran-generator](https://github.com/logoran/generator)里，算是集成一些所谓的最佳实践吧

## Tech Stack

- Logoran
- nodemon（支持async/await）
- pm2 for deployment（服务器部署）
- express-style middlewares
  - logoran-router
  - koa-views
  - koa-static
  - koa-body

## Getting Start

```
git clone https://github.com/logoran/demo.git
cd logoran-demo
npm install
npm start
```

open in browser

http://127.0.0.1:3000/ 

## 启动方式

最简单启动方式

```
node bin/run
```

最常用的集成nodemon的方式,代码变动会自动重载(其实就是nodemon去执行bin/run)

```
npm start
```

支持pm2部署

```
 #npm run pm2
 pm2 start bin/run 
```
## 支持koa的3种中间件写法

Logoran是一个 middleware framework, 它提供了 3 种不同类型的中间件写法

- common function
- async function（新增）
- generatorFunction

详见[koa的文档](https://github.com/koajs/koa/blob/v2.x/Readme.md)

## 支持view层多种模板


`koa-views` is using [consolidate](https://github.com/tj/consolidate.js) under the hood.

[List of supported engines](https://github.com/tj/consolidate.js#supported-template-engines)


需要注意的koa使用的koa-views也是下一版本的koa-views@next，当前项目已经处理过了，不需要再处理的，哈哈


### jade 

```
npm i -S jade
```

in app.js

```
app.use(views(__dirname + '/views', {
  extension: 'jade'
}));
```

### ejs

```
npm i -S ejs
```

in app.js

```
app.use(views(__dirname + '/views-ejs', {
  extension: 'ejs' 
}));
```

## 目录结构

```
➜  logoran-demo git:(master) tree . -L 2
.
├── LICENSE
├── README.md
├── app.js
├── bin
│   ├── run
│   └── www
├── node_modules
│   ├── co
│   ├── debug
│   ├── ejs
│   ├── jade
│   ├── koa-body
│   ├── koa-onerror
│   ├── koa-static
│   ├── koa-views
│   ├── logoran
│   ├── logoran-logger
│   ├── logoran-router
│   ├── logoran-run
│   └── nodemon
├── package.json
├── public
│   ├── images
│   ├── javascripts
│   └── stylesheets
├── routes
│   ├── index.js
│   └── users.js
├── views
│   ├── error.jade
│   ├── index.jade
│   └── layout.jade
└── views-ejs
    ├── error.ejs
    └── index.ejs

24 directories, 13 files
```

说明

- bin/run(logoran-run执行bin/www)
- bin/www是常规logoran启动文件，和express的一样
- views是放默认的jade文件
- views-ejs是放ejs文件


## 推荐

如果你喜欢express风格的生成，推荐[logoran-generator](https://github.com/logoran/generator)

如果你喜欢babel + logoran可以参考[Minimal koa v2 boilerplate.](https://github.com/geekplux/koa2-boilerplate)

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