yukon - npm Package Compare versions
Comparing version 0.1.0 to 0.1.1
| { | ||
| "name": "yukon", | ||
| "version": "0.1.0", | ||
| "version": "0.1.1", | ||
| "description": "Self-discovering component-based API-driven framework based on express", | ||
@@ -5,0 +5,0 @@ "main": "yukon.js", |
@@ -6,5 +6,5 @@ # yukon API framework | ||
| yukon is a component-based framework built on top of node/express - which calls 0-N REST APIs in parallel - and extends the [nodulejs framework](https://github.com/jackspaniel/nodulejs). | ||
| yukon is a component-based framework built on top of node/express - which processes 0-n REST APIs in parallel for each express request. It extends the [nodulejs component framework](https://github.com/jackspaniel/nodulejs). | ||
| "nodules" are self-discovering, self-initializing web components, which propagate throughout the express middleware chain as __req.nodule__. nodulejs was split off from yukon to separate out the core self-discovery and initialization features - which could be used as a potential building block for a wide variety of frameworks. | ||
| "nodules" are self-discovering, self-initializing web components, which propagate throughout the express middleware chain as __req.nodule__. Nodulejs was split off from yukon to separate out the core self-discovery and initialization features. These potentially could be used as a building block for a wide variety of frameworks. | ||
@@ -21,6 +21,6 @@ ## Installation | ||
| + __app__ = express instance. | ||
| + __config__ = any custom properties you want to add or defaults you want to override. See the [demoApp](https://github.com/jackspaniel/yukon/blob/master/demo/demoApp.js) for an example of a workin yukon app. See the Config section below more details on config options. | ||
| + __config__ = any custom properties you want to add or defaults you want to override. See the [demoApp](https://github.com/jackspaniel/yukon/blob/master/demo/demoApp.js) for an example of a working yukon app. See the Config section below more details on config options. | ||
| ## What is a yukon nodule? | ||
| A __nodule__ is a self-discovering, self-initializing component that would be to a JSP or PHP page in those worlds. A __yukon nodule__ extends the base nodule behavior to include back-end API calls, stub-handling and template-rendering. | ||
| A __nodule__ is a self-discovering, self-initializing component that would be to a JSP or PHP page in those worlds. A __yukon nodule__ extends the base nodule behavior to include REST API data gathering, stub-handling and template-rendering. | ||
@@ -34,3 +34,3 @@ Unlike the PHP/JSP worlds however, a nodule's route is declared and not tied by default to the filename or folder structure. So you are free to re-organize nodules without upsetting urls. But more importantly, because nodules are self-discovering, there are no onerous config files to maintain (IE - Spring). This system allows a much more scalable architecture on large sites--as there are no config or other shared files which grow to enormous sizes as the site grows, and nodules can be re-organized with zero impact. | ||
| From a __framework-development point of view__, we knew that as requirements evolved, we would constantly need to add default properties to each component, while hopefully causing as little disruption as possible to existing components. This is easily accomplished by adding a default property to the base config then specifying the property only in the nodules that need the new property. | ||
| From a __framework-development point of view__, we knew that as requirements evolved, we would constantly need to add default properties to each component, while hopefully causing as little disruption as possible to existing components. This is easily accomplished by adding a default property to the base config, then specifying the property only in the nodules that need the new property. | ||
@@ -51,7 +51,7 @@ We also knew we'd need to add slices of business logic globally or semi-globally at any point in the request chain. By keeping control of the middleware chain we are able to do this with ease. | ||
| *Note: You may occasionally see "MAGIC ALERT" below, this is for the handful of times where the framework does some convenience method that isn't immediately obvious, but comes up so much we felt the code saving was worth the loss in conceptual clarity.** | ||
| *Note: You may occasionally see "MAGIC ALERT" below. This is for the handful of times where the framework does some convenience method that isn't immediately obvious, but comes up so much we felt the code saving was worth the loss in conceptual clarity.* | ||
| ### Nodule-specific properties (config.noduleDefaults) | ||
| Yukon inherits the 4 core [nodulejs]([yukon API framework](https://github.com/jackspaniel/nodulejs) defaults: | ||
| Yukon inherits the 4 core [nodulejs](https://github.com/jackspaniel/nodulejs) defaults: | ||
@@ -92,3 +92,3 @@ 1. __route__: <span style="color:grey">(REQUIRED)</span> one or more express routes - can be a string, RegExp, or array of either | ||
| An app can create and use 4 optional express middleware functions, which splice in between the built-in yukon middleware (see [yukon.js](https://github.com/jackspaniel/yukon/blob/master/yukon.js) for more detail: | ||
| An app can create and use 4 optional express middleware functions, which splice in between the built-in yukon middleware (see [yukon.js](https://github.com/jackspaniel/yukon/blob/master/yukon.js) for more detail): | ||
@@ -107,3 +107,3 @@ 1. __appStart:__ called at start of middleware, before nodule.preProcessor | ||
| There are also 3 global config properties inherited from [nodulejs]([yukon API framework](https://github.com/jackspaniel/nodulejs): | ||
| There are also 3 global config properties inherited from [nodulejs](https://github.com/jackspaniel/nodulejs): | ||
@@ -301,5 +301,5 @@ 1. __dirs__: <span color="grey">(OPTIONAL, default='/nodules')</span> *path(s) to look for your nodules, exclude property can be full or partal match* <br>__example:__ [{ path: '/app', exclude: ['demoApp.js', '.test.js', '/shared/'] }, { path: '/lib/nodules', exclude: ['.test.js'] }] | ||
| [npm-image]: https://img.shields.io/npm/v/nodulejs.svg?style=flat | ||
| [npm-url]: https://www.npmjs.com/package/nodulejs | ||
| [downloads-image]: https://img.shields.io/npm/dm/nodulejs.svg?style=flat | ||
| [downloads-url]: https://npmjs.org/package/ndoulejs | ||
| [npm-image]: https://img.shields.io/npm/v/yukon.svg?style=flat | ||
| [npm-url]: https://www.npmjs.com/package/yukon | ||
| [downloads-image]: https://img.shields.io/npm/dm/yukon.svg?style=flat | ||
| [downloads-url]: https://npmjs.org/package/yukon |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-0.04%
29561