flyman v0.0.23

flyman

Flyman is a front end scaffold to help you quick start a project. Flyman is provided with many popular presets, include react-app, vue-app, koa-app and so on. You can create a new project with these presets, or complete your already existing project with code styles or lint files. And you can also write your own presets to use.

English | 中文文档

Quick Start

Install:

npm i flyman -g

Create a project:

flyman create

Presets

You can use a preset to create a project.

With a --preset or -p option:

flyman create my-project -p react-app

Or select a preset by arrow keys:

List all presets:

flyman ls-presets

There is some presets your can use:

• html5-starter: A html5 strandard and responsive web application templates, with jQuery, normalize.css and Bootstrap v4
• react-app: A web application with React, Redux, React-Router, Webpack.
• react-ts-app: A web application with React stack and TypeScript.
• vue-app: A web application with Vue, Vuex, Vue-Router, Webpack.
• koa: A Node.js application with Koa.
• express: A Node.js application with Express.
• react-koa: A web application with React stack, with SSR, and servered by Koa.
• vue-koa: A web application with Vue stack, with SSR, and servered by Koa.
• typescript-app: A TypeScript application with Webpack.
• es6-app: A ES6 application with Webpack.
• rollup-app: A ES6 application with rollup build tool.
• code-styles: A application with code style files, include eslint, editorconfig, prettierrc .etc.

Use your own preset

🛠 👷 coming soon...

File Templates

Flyman also provided some file templates to help you quick create a file. There is some tempaltes you can use.

• react-component: A React Component template
• vue-component: A Vue Component template
• editorconfig: A editor config file template
• prettier: A .prettierrc template
• tsconfig: A TypeScript config file tsconfig.json template
• tslint: A TypeScript lint config file tslint.json template
• eslint: A eslint config file .eslintrc template
• babelrc: A babel config file .babelrc template

You can use flyman new to create a file step by step:

Or you can create a file with -t option like following examples:

Create a React Component:

flyman new ./Detail.jsx -t react-component

Create a Vue Component:

flyman new ./Product.vue -t vue-component

Create a editorconfig file:

flyman new .editorconfig -t editorconfig

List all templates:

flyman ls-templates

Help

Your can run flyman -h or flyman --help for a help.

Usage: flyman [options] [command]

Options:
  -V, --version                   output the version number
  -h, --help                      output usage information

Commands:
  create [options] [projectName]  create a project with a project name
  new [options] [fileName]        create a file with a template
  ls-presets                      list all presets
  ls-templates                    list all templates

Examples:
  $ flyman create my-project
  $ flyman create my-project -p react-app
  $ flyman new ./Product/index.jsx -t react-component
  $ flyman new ./NewList.vue -t vue-component

LICENSE

MIT License