Skip to content
This repository has been archived by the owner on May 23, 2022. It is now read-only.

Commit

Permalink
created README and added other meta files
Browse files Browse the repository at this point in the history
  • Loading branch information
tomwayson committed Jun 11, 2014
1 parent 9d86e17 commit 51d8941
Show file tree
Hide file tree
Showing 8 changed files with 146 additions and 30 deletions.
1 change: 1 addition & 0 deletions AUTHORS.md
@@ -0,0 +1 @@
Tom Wayson <twayson@esri.com> (https://github.com/tomwayson)
1 change: 1 addition & 0 deletions CONTRIBUTING.md
@@ -0,0 +1 @@
We welcome contributions from anyone and everyone. Please see the Esri [guidelines for contributing](https://github.com/esri/contributing).
104 changes: 84 additions & 20 deletions README.md
@@ -1,47 +1,111 @@
# generator-esri-webapp-builder [![Build Status](https://secure.travis-ci.org/tomwayson/generator-esri-webapp-builder.png?branch=master)](https://travis-ci.org/tomwayson/generator-esri-webapp-builder)

> [Yeoman](http://yeoman.io) generator
> [Yeoman](http://yeoman.io) generator to help customize [Esri's WebApp Builder](http://video.esri.com/watch/3211/web-app-builder).
## About

## Getting Started

### What is Yeoman?
This generator scaffolds out the boilerplate files that are needed when you are customizing the WebApp Builder. This includes [generators](#running-the-generators) to creates project files (`package.json`, `.jshintrc`, etc) and scaffold out the files needed to create a new custom widget

Trick question. It's not a thing. It's this guy:
![Screenshot](https://raw.githubusercontent.com/tomwayson/generator-esri-webapp-builder/master/docs/images/running-the-generators.png)

![](http://i.imgur.com/JHaAlBJ.png)
## Getting Started

Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.
### Installation

Not every new computer comes with a Yeoman pre-installed. He lives in the [npm](https://npmjs.org) package repository. You only have to ask for him once, then he packs up and moves into your hard drive. *Make sure you clean up, he likes new and shiny things.*
To install Yeoman from npm (if not already), run:

```bash
$ npm install -g yo
```

### Yeoman Generators

Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.

To install generator-esri-webapp-builder from npm, run:

```bash
$ npm install -g generator-esri-webapp-builder
```

Finally, initiate the generator:
### Running the Generators

The generators should be run in the root folder of either the stem app or an app that you've already created with the WebApp Builder.

#### App (Default) Generator

Currently the app generator doesn't do much other than install some project files (`package.json`, `.jshintrc`, etc) and ensure required subfolders (like `widgets`) exist. The subgenerators do most of the work.

1. Navigate into either `stemapp` or `builder/apps/[appId]/widgets` under your local WebApp Builder installation
2. Run the generator with `yo esri-webapp-builder`
3. Answer the man's questions!

|Prompt|Description|Default|
|------|-----------|-------|
|Author|Name of developers or organization for widget manifests|Your Name or Organization|

#### Widget Generator

Scaffolds out the files needed to create a new custom widget.

1. Navigate into either `stemapp` or `builder/apps/[appId]/widgets` under your local WebApp Builder installation
2. Run the generator with `yo esri-webapp-builder:widget`
3. Answer the man's questions!

|Prompt|Description|Default|
|------|-----------|-------|
|Widget Name|Folder name for output files and widget identifier|MyWidget|
|Widget Title|Name users see in widget selector and panel title bar|My Widget|
|Description|What does this widget do? (optional)|A custom WebApp Builder widget|
|CSS Prefix|Prefix for the widget's base class (optional)|myapp-|
|Will your widget run inside a panel?|Will your widget run inside a panel?|Yes|

Taking the default values for the prompts will generate the following output under the `widgets` folder:

```bash
$ yo esri-webapp-builder
```
MyWidget
│ config.json
│ manifest.json
│ Widget.html
│ Widget.js
├───css
│ style.css
├───images
│ icon.png
└───nls
strings.js
```

The next time you run the WebApp Builder, you will see something like the following on the widgets panel:

![Widget in the Builder](https://raw.githubusercontent.com/tomwayson/generator-esri-webapp-builder/master/docs/images/widget-in-builder.png)

## Issues

Find a bug or want to request a new feature? Please let us know by [submitting an issue](https://github.com/tomwayson/generator-esri-webapp-builder/issues).

## Contributing

We welcome contributions from anyone and everyone. Please see Esri's [guidelines for contributing](https://github.com/esri/contributing).

## Credit

This generator was inspired by [@steveoh](https://github.com/steveoh) and [@stdavis](https://github.com/stdavis)'s [generator-dojo-widget](https://github.com/steveoh/generator-dojo-widget) as well as [@dbouwman](https://github.com/dbouwman)'s [generator-bootmap](https://github.com/dbouwman/generator-bootmap).

### Getting To Know Yeoman
## Licensing

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

If you'd like to get to know Yeoman better and meet some of his friends, [Grunt](http://gruntjs.com) and [Bower](http://bower.io), check out the complete [Getting Started Guide](https://github.com/yeoman/yeoman/wiki/Getting-Started).
http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

## License
A copy of the license is available in the repository's [license.txt]( https://raw.github.com/Esri/esri-leaflet/master/license.txt) file.

MIT
[](Esri Tags: "WebApp Builder" yeoman generator)
[](Esri Language: JavaScript)
11 changes: 6 additions & 5 deletions app/index.js
Expand Up @@ -10,11 +10,12 @@ var EsriWebappBuilderGenerator = yeoman.generators.Base.extend({
init: function () {
this.pkg = require('../package.json');

this.on('end', function () {
if (!this.options['skip-install']) {
this.installDependencies();
}
});
// no dependencies in package.json (yet)
// this.on('end', function () {
// if (!this.options['skip-install']) {
// this.installDependencies();
// }
// });
},

askFor: function () {
Expand Down
Binary file added docs/images/running-the-generators.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/widget-in-builder.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 48 additions & 0 deletions license.txt
@@ -0,0 +1,48 @@
Apache License – 2.0

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.

"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:

1. You must give any other recipients of the Work or Derivative Works a copy of this License; and
2. You must cause any modified files to carry prominent notices stating that You changed the files; and
3. You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
4. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS
11 changes: 6 additions & 5 deletions package.json
@@ -1,13 +1,13 @@
{
"name": "generator-esri-webapp-builder",
"version": "0.0.0",
"description": "Yeoman generator",
"version": "0.0.1",
"description": "Yeoman generator to help customize Esri's WebAppBuilder",
"license": "MIT",
"main": "app/index.js",
"repository": "tomwayson/generator-esri-webapp-builder",
"author": {
"name": "Tom Wayson",
"email": "",
"email": "twayson@esri.com",
"url": "https://github.com/tomwayson"
},
"engines": {
Expand All @@ -17,10 +17,11 @@
"test": "mocha"
},
"files": [
"app"
"app",
"widget"
],
"keywords": [
"yeoman-generator"
"yeoman-generator", "Esri", "WebApp Builder"
],
"dependencies": {
"yeoman-generator": "~0.16.0",
Expand Down

0 comments on commit 51d8941

Please sign in to comment.