1.4.1 • Published 5 years ago
@mhy/boot v1.4.1
Warning
Tool in BETA version. Use the tool at your own risk.
@mhy/boot
With @mhy/boot
you'll be able to start codebases in the
current src
directory.
Templates
Currently @mhy/boot has a simple default
template available,
but we're looking forward on having more templates
available in the long run.
React Default Template
The current default
template is a React project and it
contains the following structure:
components
: components directoryconfig
: app configuration directorycore
: app mounting, routing and flux store directoryentities
: HTTP code related directoryfields
: app specific form fields directoryforms
: app specific forms and business logic directorylayouts
: is a container for a page to represent different states of an applicationoverlays
: basically containers to construct a overlay's structure.pages
: basically containers to construct a page's structure.services
: a base service implementation which you build your APIs on.validators
: custom validator function usually forreact-redux-form
index.js
: files are being used to export sub-modules for easier/simplier/nicer imports.
How to use it
# mhy boot [technology:react|vue|...] [template:default|...] [-o,--output: output path]
mhy-boot Options
technology
: what technology should boot@mhy/boot
boot.default
: react
tempalte
: what template should be loaded.default
: default
-o, --output
: path where the template should be booted.default
: src
# Example:
mhy boot react default -o src
# or:
# mhy boot
# or:
# mhy boot react
# or:
# mhy boot -o xproject/path/src