Package Exports

create-3h-app

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (create-3h-app) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

create-3h-app

A simple app initializer.

Introduction

This is a CLI tool that helps you quickly initialize a development environment for your awesome front-end app.

Usage

$ create-3h-app --help
A simple app initializer.

Usage:
  create-3h-app [options]

Options:
  --name, -n <pkg>              The name of the package
  --author, -a <name>           The author of the package
  --desc, -d <description>      The description of the package
  --keywords, -k <words...>     The keywords of the package
  --repo, -r <repository>       The repository of the package
  --no-install                  Do not install dependencies instantly
  --help, -h                    Show help info

Example

npm init 3h-app -n my-awesome-app -a Peter -d "This is my awesome lib"
# or
npx create-3h-app -n my-awesome-app -a Peter -d "This is my awesome lib"

Template Structure

your-awesome-app/
+-- public/
| +-- index.html
| `-- index.css
+-- src/
| `-- index.js
+-- test/
| `-- index.html
+-- .gitignore
+-- LICENSE
+-- README.md
+-- rollup.config.js
`-- dev-server.js

Workflow

Generally, you

Write your source code in the src folder
Test your app using the dev server(by executing npm test) which loads your source code directly
Build your app by executing npm run build
Deploy your app in the public directory

Built-in Scripts

name	description
`test`	launch the dev server
`build`	build your code

The development server employs herver to serve your app for testing. It will serve your source code directly from src, so after you change something in your source code, you can just refresh the page to test it. Other resource files are supposed to be put in the public folder, and they will be served properly. Additionally, files of local libs inside /node_modules can be loaded by using URLs starting with /node_modules.

After building your code by executing npm run build, a bundled JavaScript file(index.js) will be placed in the public folder, which will be transformed by babel, bundled by rollup and minified by terser. Finally, you will get your app in the public folder.