Skip to content

Latest commit

 

History

History
68 lines (41 loc) · 2.88 KB

README.md

File metadata and controls

68 lines (41 loc) · 2.88 KB

cli-create-app

Build Status Build status codecov npm version

The create app command for the dojo cli.

WARNING This is beta software. While we do not anticipate significant changes to the API at this stage, we may feel the need to do so. This is not yet production ready, so you should use at your own risk.

Usage

To use @dojo/cli-create-app, install the project globally along side dojo cli:

npm install -g @dojo/cli-create-app

Run using:

dojo create [app] --name <appName>

Features

@dojo/cli-create-app generates a skeleton project structure for Dojo 2 into a directory using the the --name argument provided.

All the dependencies have been pre-installed using npm including two @dojo/cli commands; @dojo/cli-build-webpack and @dojo/cli-test-intern.

To start using the application, cd into the directory and run dojo build --watch which will build and serve the application on port 9999. Open http://localhost:9999 in a modern browser (Chrome, FF, Safari, IE11 or Edge) to run the application.

For testing the application run dojo test, which will build the application (src and tests) and run all test in node.

When ready to create a production build run dojo build, the output will be available in the dist directory.

How do I contribute?

We appreciate your interest! Please see the Dojo 2 Meta Repository for the Contributing Guidelines and Style Guide.

Installation

To start working with this package, clone the repository and run npm install.

In order to build the project run grunt dev or grunt dist.

Testing

Test cases MUST be written using Intern using the Object test interface and Assert assertion interface.

90% branch coverage MUST be provided for all code submitted to this repository, as reported by istanbul’s combined coverage results for all supported platforms.

To test locally run:

grunt test

Licensing information

© 2017 JS Foundation. New BSD license.