@dojo/cli-create-app

cli-create-app

The create app command for @dojo/cli.

• Usage
• Features
• How do I contribute?
  • Code Style
  • Installation
  • Testing
• Licensing information

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 are pre-installed using npm including two @dojo/cli commands; @dojo/cli-build-app and @dojo/cli-test-intern.

To start using the application, cd into the directory and run dojo build --mode dev --watch memory --serve 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.

To build the tests, run dojo build --mode test. This will output to output/test.

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

How do I contribute?

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

Code Style

This repository uses prettier for code styling rules and formatting. A pre-commit hook is installed automatically and configured to run prettier against all staged files as per the configuration in the projects package.json.

An additional npm script to run prettier (with write set to true) against all src and test project files is available by running:

npm run prettier

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

© 2018 JS Foundation. New BSD license.