The toman from foliejs

toman's Introduction

  _____      U  ___ u   __  __       _        _   _     
 |_ " _|      \/"_ \/ U|' \/ '|u U  /"\  u   | \ |"|    
   | |        | | | | \| |\/| |/  \/ _ \/   <|  \| |>   
  /| |\   .-,_| |_| |  | |  | |   / ___ \   U| |\  |u   
 u |_|U    \_)-\___/   |_|  |_|  /_/   \_\   |_| \_|    
 _// \\_        \\    <<,-,,-.    \\    >>   ||   \\,-.
(__) (__)      (__)    (./  \.)  (__)  (__)  (_")  (_/

A module for taking advantage of the built-in node project in node LTS according to auto generation config.

Installation

yarn global add toman

Installation lastest version

yarn global upgrade toman

Usage

Initialize toman plugin with the generated project, with the given options.

Options:

project select project
type project type
port project port
name project name
h display help
no-color disable color
quiet quiet mode - only displays warn and error messages

Example

// generate typescript webapp base on react
toman g webapp --name web --port 10022

// generate api service base on koa1.0
toman g api --name apiservice --port 10023

api Directory Layout

├── config/                     # constant config
│   locales/                    # string id translate
│   pm2/                        # deploy script
│   ├── 21.json                 # test script
│   ├── ga.json                 # ga script
│   └── release.json            # release script
├── lib/                        # application source code
│   ├── api/                    # api controller
│   ├── middleware/             # api middleware
│   ├── schemas/                # database
│   ├── services/               # third part service
│   ├── route.js                # api routes
│   └── app.js                  # backend entry point.
├── node_modules/               # libraries and utilities
├── app.js                      # startup
├── package.json                # project pkg
├── skyfile.js                  # deploy script
├── .gitignore                  # ignore file
├── .gitlab-ci.yml              # ci test
└── test/                       # Unit tests and test-cov

webapp Directory Layout

├── config/                     # constant config
├── mock/                       # mock test
│   pm2/                        # deploy script
│   ├── 21.json                 # test script
│   ├── ga.json                 # ga script
│   └── release.json            # release script
├── src/                        # application source code
│   ├── app/                    # application config
│   ├── common.ts               # common ts
│   ├── global.d.js             # global varible
│   ├── index.html              # start page
│   ├── home.index.mustache               # start ts
│   └── style.ts                # style reference
├── node_modules/               # libraries and utilities
├── postcss.config.js           # post css cfg
├── tsconfig.json               # ts cfg
├── tsconfig.mock.json          # mock config
├── tslint.json                 # eslint standard  
├── package.json                # project pkg
├── skyfile.js                  # deploy script
├── .gitignore                  # ignore file
├── .gitlab-ci.yml              # ci test
└── test/                       # Unit tests and test-cov

Screenshot

License

MIT License

toman's People

Contributors

Stargazers

Watchers

toman's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because we are using your CI build statuses to figure out when to notify you about breaking changes.

Since we did not receive a CI status on the greenkeeper/initial branch, we assume that you still need to configure it.

If you have already set up a CI for this repository, you might need to check your configuration. Make sure it will run on all new branches. If you don’t want it to run on every branch, you can whitelist branches starting with greenkeeper/.

We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

Recommend Projects