generator-koa-sudiyi

A yo generator with koa.js from sudiyi.

Usage no npm install needed!

<script type="module">
  import generatorKoaSudiyi from 'https://cdn.skypack.dev/generator-koa-sudiyi';
</script>

README

generator-koa-sudiyi

A yo generator with koa.js from sudiyi.

NPM Version Coverage Status Build Status Downloads Dependency Status License

Installation

First, install Yeoman and generator-koa-sudiyi using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-koa-sudiyi

Then generate your new project:

yo koa-sudiyi

What do you get?

Scaffolds out a complete generator directory structure for you:

.
├── .gitignore
├── .jshintrc
├── README.md
├── app.js
├── lib
│   ├── const
│   │   └── index.js
│   ├── controllers
│   │   └── index.js
│   ├── db
│   │   ├── mysql-redis-cache.js
│   │   ├── mysql.js
│   │   └── redis.js
│   ├── index.js
│   ├── logger
│   │   └── index.js
│   ├── middlewares
│   │   ├── filter.js
│   │   ├── koa-log4js.js
│   │   ├── request-id.js
│   │   └── x-response-time.js
│   ├── models
│   │   └── index.js
│   ├── routes
│   │   └── index.js
│   ├── schemas
│   │   └── index.js
│   ├── services
│   │   └── index.js
│   └── utils
│       ├── helper.js
│       ├── qiniu.js
│       └── resp-code-handler.js
├── package.json
├── pm2.json
└── public

Run the demo

After the installation, we could run script to start server (http://localhost:3333).

npm start

Versions

1.0.0

The formal version of this generator. Works properly.

Will keep eyes on module update.

1.0.2

Tiny modify to Sequlize version to 3.13.0 (Because 3.14.3 will cause promise warning).

1.0.3

Modify index.js for further mocha test(next version will add a sample).

Remove the useless modules and add co-mocha, co-supertest to package.json

1.1.0

Simplify the node modules required and add logger, routes and some common middlewares.

2.0.0

Change project structure to make it more reasonable. Update dependencies packages and their version.

Getting To Know Sudiyi

Sudiyi is cool to help user to collect online shopping packages.

Getting To Know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced. Feel free to learn more about him.

License

MIT © Bo Li (solee.me)