A simple CLI that help create express app more easily


Keywords
express, expressjs, genge, cli, quick, setup, website, webapp
License
MIT
Install
npm install genge@1.8.0

Documentation

Genge

yarn global add https://github.com/felixfong227/genge.git

or

npm -g install https://github.com/felixfong227/genge.git

A simple ExpressJS template generator

CLI:

$ genge [option] [option] --flat --flat

Create your first app

$ genge add app pony.com

Genge will create some start up folders and files

.
β”œβ”€β”€ index.js
β”œβ”€β”€ node_modules/
β”œβ”€β”€ package.json
β”œβ”€β”€ public/
β”‚Β Β  β”œβ”€β”€ index.ejs
β”‚Β Β  └── style.css
β”œβ”€β”€ router/
β”‚Β Β  └── login.js
└── yarn.lock

And with the --run flat, what you can do is as soon as Genge finish creating thought files and folder, it will run the app right a way

Remove your app

$ genge remove app pony.com

Install packages

Once Genge finish create the files, then it will start install some necessary packages such as express

By defualt Genge will run:

$ npm install

But if you want to use the Yarn, what you can do it using that yarn flat --yarn

$ yarn install

Runing the app

You can use the --run flat to tell Genge run the app as soon as everything is OK

Open the web site right a way

You can also use the --open flat to tell Gegen then everything is OK, open the browser and load your express app

PS: Require the --run flat to do so

Router

Create a new router

$ genge add router pony/ponyville/isfun
.
β”œβ”€β”€ index.js
β”œβ”€β”€ package.json
β”œβ”€β”€ public/
β”‚Β Β  β”œβ”€β”€ index.ejs
β”‚Β Β  └── style.css
β”œβ”€β”€ router/
β”‚Β Β  β”œβ”€β”€ login.js
β”‚Β Β  └── pony/
β”‚Β Β      └── ponyville/
β”‚Β Β          └── isfun.js
└── yarn.lock

Removing the router

$ genge remove router pony/ponyville/isfun

Config file

This version of Genge, what you can config is

  1. Package Installer (NPM, Yarn)
  2. Router path(Default: ./router);
$ genge config packageinstaller
$ genge config routerpath

View the config file

$ genge config show

Genge will output the content of the globalConfig.json

Update

$ genge update
$ genge update --beta

Check for updates

By default, Genge will fetching data from the NPM registry

And what the --beat flat, Genge will instead fetching data from the GitHub repository

PS: For this verson of Genge, will only notif you, and won't update the app itself

Cloud config

Grap the JSON file from the internet(cloud)

So you can start sharing your config file via Gist with your friends

$ genge config cloud <URL>https://gist.github.com/gengeConfig.json<URL>