# generator-eydis

> Yeoman generator

Latest version **0.0.10** (published 2014-09-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install generator-eydis
pnpm add generator-eydis
yarn add generator-eydis
bun add generator-eydis
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.10 |
| Published | 2014-09-15 |
| First published | 2014-07-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jonathan Wayne Parrott |
| Maintainers | jonparrott |
| Keywords | yeoman-generator |

## Links

- npm: https://www.npmjs.com/package/generator-eydis
- Repository: https://github.com/jonparrott/generator-eydis
- Issues: https://github.com/jonparrott/generator-eydis/issues
- npm.io page: https://npm.io/package/generator-eydis

## Dependencies (4)

- [chalk](https://npm.io/package/chalk.md) ~0.4.0
- [yosay](https://npm.io/package/yosay.md) ^0.1.0
- [inflection](https://npm.io/package/inflection.md) ^1.3.8
- [yeoman-generator](https://npm.io/package/yeoman-generator.md) ~0.16.0

## Recent versions

- 0.0.10 (latest) — 2014-09-15
- 0.0.9 — 2014-09-11
- 0.0.8 — 2014-09-03
- 0.0.7 — 2014-09-03
- 0.0.6 — 2014-08-06
- 0.0.5 — 2014-07-25
- 0.0.4 — 2014-07-25
- 0.0.3 — 2014-07-24
- 0.0.2 — 2014-07-24
- 0.0.1 — 2014-07-21
- 0.0.0 — 2014-07-18

## README

Eydís [Yeoman](http://yeoman.io) generator
==========================================

What is Eydís?
--------------

Eydís is a starter application for single-page applications that use AngularJS, Google Sign-in, and Google Cloud Endpoints.

Getting Started
---------------

Install Yeoman

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

Install the generator

```bash
$ npm install -g generator-eydis
```

Run the generator

```bash
$ yo eydis
```

Run gulp to develop

```bash
$ gulp watch
```

Developing Locally
------------------

 * Install the [LiveReload chrome extension](https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei).
 * Run ``gulp watch``. It'll start the server and open your browser.
 * Make sure LiveReload is enabled by clicking the button next to the toolbar.
 * Anytime you change a file in app (js, less, or html) the browser should auto-reload.
 * If you don't like auto-reload just click the button to turn off the extension.
 * Bower dependencies and js files in app are automatically wired. See the next two sections.


Installing and using dependencies
---------------------------------

  * Use bower. For example, to install the moment library use ``bower install --save moment``. It's important to use ``--save`` as it'll update the bower.json file with the new dependency.
  * The ``wiredep`` utility will automatically include the new depedency in ``index.html``. If you're using ``gulp watch`` then it's already happened, but you can run it manually using ``gulp wiredep``.


Automatic script wiring
-----------------------

All js files in ``app`` will be automatically included into ``index.html``. You don't have to do anything to make this happen if you're using ``gulp watch`` but you can run ``gulp wirescripts`` to trigger it manually. **Note** that no files ending in ``_test.js`` will be included.

Running Tests
-------------

Unfortunately Karma isn't well integrated into gulp yet. I'm waiting on some plugins to come into maturity. In the meantime you can run karma directly. Tests specs should live alongside the file/module they test. For example, ``users.js`` would be tested by ``users_test.js``.

 * Run ``karma start``.
 * It should detect and run all files in app.
 * However, it does not automatically wire bower depedencies. Edit ``karma.conf.js`` to add them.


Building & deploying
--------------------

To build your application simply run ``gulp build`` or just ``gulp`` (build is the default task). This task does quite a lot of things.

  * It builds the app inside of the ``dist`` folder.
  * It concats and minifies all js and css. External css and js is prepared into ``vendor.css`` and ``vendor.js``, respectively. Internal css and js is prepared into ``styles.css`` and ``scripts.js``, respectively.
  * It compiles all html files used by angular into a single js file. This neat trick means that angular never has to make a request to load a template file.
  * It copies over static assets like images, fonts, etc.
  * It prepares an ``app.yaml`` file for you.
  * More.

Once build is finished you can run your application by running:

    cd dist
    app-server

You can do all of this in one step by running ``gulp serve:dist``.

You can deploy using the normal ``appcfg.py`` tool from the ``dist`` folder.

If you need to prepare a debug build use ``gulp build:debug``.


License
-------

Apache, Version 2

---
_Source: https://npm.io/package/generator-eydis · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._