generator-donejs


A Yeoman generator for your DoneJS application. Available generators are:

- app to create a new DoneJS application
- plugin to create a new DoneJS plugin
- generator to create a new DoneJS generator project

- component to create a CanJS component
- supermodel to create a can-connect connection
- module to generate a general purpose modlet

Using generators

__Important:__ While this repository is a Yeoman generator it should only be used directly with the DoneJS cli instead of the yo command line.

With the CLI installed via

``shell
npm install donejs -g
`

The following commands are available. To initialize a new DoneJS related project:

- donejs add app [projectname] create a new DoneJS application
- donejs add plugin [projectname] create a new DoneJS plugin
- donejs add generator [projectname] create a new generator project

Within a DoneJS application or plugin:

- donejs add component to create a CanJS component
- donejs add supermodel to create a can-connect connection
- donejs add module to generate a general purpose modlet

donejs add app

Creates a new DoneJS application. Running this command will install dependencies and initial configuration.

`shell
donejs add app
`

!donejs add app

Configuration

Most questions are to fill in values into the package.json and the defaults can be accepted. The following questions have special meaning:

$3

This specifies the folder where your application's source code is contained. By default the value is src creating a file structure like:

`shell
- my-awesome-app/
|
├ src/
├ index.stache
`

Generated folder

Using donejs add app will generate a folder that contains several files used for development. The following files are noteworthy:

$3

An HTML file used to view the application in development mode without requiring server-side rendering. You can use this file instead of done-serve if your application doesn't require server-side rendering.

development.html uses hash based routing so that it can be used with any HTTP server.

!app using development.hml

$3

An HTML file that will load the application in production mode. This is useful to test the application's build without server-side rendering, or in cases where you do not need server-side rendering, to serve the application to the end users.

> Note: Opening this page before running donejs build will result in errors. Running that command should clear up the errors.

$3

This is the build script for generating bundles for deploying the application to production. It uses steal-tools to create optimized bundles with progressive loading included by default.

> Note: This file is modified by some generators such as donejs-cordova but can be edited by you as well.

$3

This is the root template for your application. Here you can:

* Add , and