| 1 | rupert-grunt
|
| 2 | =================
|
| 3 |
|
| 4 | rupert development toolchain and library.
|
| 5 |
|
| 6 | ## Starting a new project
|
| 7 |
|
| 8 | 1. Create a new project.
|
| 9 | 1. On Github, set the name and description. Generate a Readme and license.
|
| 10 | 1. Clone the project from GitHub.
|
| 11 | 1. Run `npm init ; npm i --save rupert ; npm i --save-dev grunt rupert-grunt`.
|
| 12 | 1. While npm is smart in initialization, you can set a name, etc in your [npmrc][npmrc]
|
| 13 | 1. Run `cp node_modules/rupert-grunt/plain/* .` (See [the source directory here][plain_folder]).
|
| 14 | 1. Edit the `name` field in `./server.json`.
|
| 15 | 1. Add npm scripts:
|
| 16 | 1. `"start": "node ./app.js"`
|
| 17 | 1. `"test": "./node_modules/.bin/grunt"`
|
| 18 |
|
| 19 | [npmrc]: https://www.npmjs.org/doc/misc/npm-config.html#config-settings
|
| 20 | [plain_folder]: https://github.com/DavidSouther/rupert-grunt/tree/master/plain
|
| 21 |
|
| 22 | ## Project Layout
|
| 23 |
|
| 24 | ### Client Code
|
| 25 |
|
| 26 | ### Server APIs & Endpoints
|
| 27 |
|
| 28 | ## The Pieces
|
| 29 |
|
| 30 | Built from two and a half years experience with Angular, and nearly a decade of experience with full-stack web development, ng-stassets-grunt is a project library and template that will have any team up and running in minutes. Handling the common cases and core infrastructure, you and your team can focus on building your application, while ng-stassets keeps up to date on the latest changes and security updates in the MEAN ecosystem.
|
| 31 |
|
| 32 | ### stassets
|
| 33 |
|
| 34 | [`stassets`](https://github.com/DavidSouther/stassets) is a compiling express middleware. When you first start the Node project, stassets scans its `root` directory for your project files (by default, Angular controller, services, directives, templates, styles, etc). Whenever those files change, stassets compiles them, storing the generated `index.html`, `vendors.js`, `application.js`, etc files in memory. When your browser requests those files, it always has the most up to date version of the development library. This approach allows for extremely rapid iteration when developing.
|
| 35 |
|
| 36 | ### rupert
|
| 37 |
|
| 38 | [`rupert`](https://github.com/DavidSouther/ng-stassets) is an express server configured to use `stassets`. It can also be configured to attach your custom API endpoints, use TLS authentication (including generating a development certificate on the fly), and configure [socket.io](http://socket.io/) for realtime data.
|
| 39 |
|
| 40 | ### MEAN
|
| 41 |
|
| 42 | MEAN is an acronym for the MEAN stack. There are many impementations of the MEAN stack; ng-stassets is YAMS (Yet Another Mean Stack).
|
| 43 |
|
| 44 | #### Express
|
| 45 |
|
| 46 | #### Angular
|
| 47 |
|
| 48 | ## Cookbook
|
| 49 |
|
| 50 | ### TDD
|
| 51 |
|
| 52 |
|
| 53 | ## Changelog
|
| 54 |
|
| 55 | * **0.0.4** *2014-10-17* Ionic fonts bug.
|
| 56 | * **0.0.3** *2014-10-12* Watchers and notifications.
|
| 57 | * **0.0.2** *2014-10-10* Runs feature tests.
|
| 58 | * **0.0.1** *2014-10-9* Runs client and server tests.
|